Preview url: https://snyk.github.io/docs/
- Pull down the repo
- In the command line, navigate to the repo's folder and run
bundle install - If there are no errors, run
jekyll serve - Go to http://localhost:4000/docs/ in your browser
Check out the Markdown-cheatsheet for how to write content.
If you want to preview a file but not let the changes show on production, add this line to the YAML front-matter:
---
draft: true
---
This will add a "draft" label and background colour.
To not show the title (such as on a landing section), add this line to the YAML front-matter:
---
title: ""
---
For inline code, such as a word, use a single backtick.
To wrap some code in a code block, use 3 backticks before and after the text.