Tutorial
Getting the repo
If you are contributing to the repository, make sure to fork this repo, and then clone your own fork. You will need to do this to make creating pull requests easier.
git clone https://github.com/<your-username>/terra-docs
Adding an article
All articles are markdown files, placed under the /src/
directory. You can create folders underneath the /src
directory, such as the following:
/src
/dev
README.md
spec-auth.md
...
/node
README.md
installation.md
...
README.md
Notice how README.md
serves as the default root of the folder.
Editing the navigation
To edit the navigation to include your new article, edit /src/.vuepress/config.js
and add your new article in the appropriate section in themeConfig.sidebar
, following the other paths as examples.
Test it out locally
Make sure you install all the dependencies:
yarn install
Build and run locally (hot-reloading dev server):
yarn docs:dev
Built With
- Vuepress
- MathJax
- Terra Docs custom theme
License
This software is licensed under the MIT license. See LICENSE for full disclosure.
© 2020 Terraform Labs, PTE.