Documentation template site for DemocracyOS.
Content is taken from /docs directory in the main repo.
Since this project uses a git submodule, we recommend you to clone this repo recursively:
git clone git@github.com:DemocracyOS/docs.git --recursive
Then run npm install to fetch all npm dependencies.
When DemocracyOS documentation is updated, to pull those changes you have to:
- On this directory,
cdintoappdirectory - Run
git pull origin master cdback to the root directory of this repository- Add the changes and commit them to the
masterbranch - After that, run
npm run deployto see those changes in the online site.
npm run build: Converts /app/docs/**/*.md files to .html using /assets for templating and saves it to /build directory.
npm run serve: Local server for development.
npm run deploy: Builds the site and commits it to gh-pages branch. So, it will be visible on http://docs.democracyos.org