Jumpstart Guides

Jumpstart Guides uses docsify to generate our guides.

The root folder of all our guides can be found in the docs folder.

To add a page, create a new Markdown file (e.g. example.md) and update the table of contents by editing _sidebar.md.

Themes

There are several themes to choose from. We are currently using docsify-themeable.

Development

Clone the repository

git clone https://github.com/thoughtworks-jumpstart/docs.git

Install dependencies

npm install

Start the server and visit http://localhost:3000/#/

npm start

See docsify's documentation https://docsify.js.org

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Elson 🖋

Jesstern Rays 🖋

Mabel Lee 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!