Verified Commit ab0f4f3c authored by Aral Balkan's avatar Aral Balkan
Browse files

Add documentation on the documentation project

parent 5476773d
title = "Docs"
This is the documentation on the documentation project (this). Very meta.
## Process
The Docs project is used both for planning artefacts and to document the various projects under the Indienet banner as they are developed.
## Development
Docs is built using [Hugo]( See the Hugo [quick start guide]( to install Hugo on your system.
We use [our fork]( of the [Hugo DocDock Theme]( The fork currently fixes [an issue with search highlighting breaking in Mermaid sequence diagrams]( (The fix [has now been merged into master](
To contribute to the project, team members should [fork the repository on]( and submit merge requests.
## Installation
1. Clone the repository
2. Install the theme (`git submodule update --init`)
## Running
hugo server -D
(This will run a local dev server and locally publish the site, including drafts.)
## Deployment
If you have deployment privileges, you can deploy via Git:
git push deploy master
This will push to the deployment mirror repository on GitHub which will trigger [Netlify]( to build it via Hugo and deploy it to [](
See [netlify.toml]( for the deployment configuration.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment