Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

massdriver-cloud/docs

Open more actions menu

Repository files navigation

Massdriver Docs

Enabling Pre-commit

This repo includes pre-commit hooks, use 'em!

Install precommmit on your system.

git init
pre-commit install

Local development

The docs are generated using Docusaurus:

yarn start
open http://localhost:3000/

Or with docker

docker run --rm -it -v $PWD:/app -w /app -p 3001:3000 node:20-alpine3.22 yarn
docker run --rm -it -v $PWD:/app -w /app -p 3001:3000 node:20-alpine3.22 yarn start

Generating GQL Docs

To update the GraphQL docs, you'll need access to generated the GraphQL SDL file from Massdriver.

cd $MASSDRIVER_DIR
mix absinthe.schema.sdl
mv schema.graphql $DOCS_DIR/schema/md.graphql
cd $DOCS_DIR
npx docusaurus graphql-to-doc

Sync CLI docs

The Massdriver CLI has markdown docs for all commands. They can be sync'd to ./cli w/ the following command:

make sync-cli-docs

About

Massdriver Docs

Resources

Stars

Watchers

Forks

Contributors

Morty Proxy This is a proxified and sanitized view of the page, visit original site.