0.0.1 • Published 5 years ago
quick-docs v0.0.1
Quick Docs
A pop-up static site for documenting your things. See the demo.
Installation
npx create-quick-docs
or
- Clone this repo or download and unzip
- From the project folder, run
npm install
oryarn
Usage
This project creates pages automatically for any .md
or .mdx
files that are
located in the /content folder.
- Run
npm run start
oryarn start
to start the development server - Add or edit
.md
or.mdx
files in the /content folder - Edit navigation content in the /content/nav folder
- Edit the theme or source components in the /src folder
- Build to production with
npm run build
oryarn build
- Host the /public folder anywhere on the web
See the demo for more detailed instructions.
Notes
Thanks to:
- John Otander for his work with gatsby-plugin-documentation - where this idea started - and MDX
- Brent Jackson for Theme UI
Contribution
To contribute to this project, visit the Github repository.
You can tweet the author at @steveruizok.
0.0.1
5 years ago