https://github.com/massdriver-cloud/docs
Massdriver Docs
https://github.com/massdriver-cloud/docs
Last synced: 7 months ago
JSON representation
Massdriver Docs
- Host: GitHub
- URL: https://github.com/massdriver-cloud/docs
- Owner: massdriver-cloud
- Created: 2022-06-06T21:48:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T18:47:28.000Z (7 months ago)
- Last Synced: 2024-11-19T19:52:16.580Z (7 months ago)
- Language: JavaScript
- Homepage: https://docs.massdriver.cloud
- Size: 215 MB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Security: docs/security/00-overview.md
Awesome Lists containing this project
README
# Massdriver Docs
### Enabling Pre-commit
This repo includes pre-commit hooks, use 'em!
[Install precommmit](https://pre-commit.com/index.html#installation) on your system.
```shell
git init
pre-commit install
```
### Local development
The docs are generated using Docusaurus:
```shell
yarn start
open http://localhost:3000/
```
Or with docker
```shell
docker run --rm -it -v $PWD:/app -w /app -p 3001:3000 node:19-alpine3.16 yarn
docker run --rm -it -v $PWD:/app -w /app -p 3001:3000 node:19-alpine3.16 yarn start
```
### Generating GQL Docs
To update the GraphQL docs, you'll need access to generated the GraphQL SDL file from Massdriver.
```shell
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](https://github.com/massdriver-cloud/mass) has markdown docs for all commands. They can be sync'd to ./cli w/ the following command:
```shell
make sync-cli-docs
```
---