Repository files navigation

This repository contains markdown for illumos.org. It is written inmkdocs.

We are using a customized version of thematerial theme.

If you're looking to help out but aren't sure where to start, please have alook at ouropen issues.

We have a number of Markdown extensions installed. See themkdocs.yml file'smarkdown_extensions section for a list.

Their documentation can be foundhere.

mkdocs is written in Python. Please see theirinstructions for details, but the shortof it is:

pip install mkdocspip install mkdocs-materialpip install markdown-include

Clone this repo. Create a topic branch. Make your changes.

Assuming you havemkdocs installed, you can simply domkdocs serve to starta local test server.

19:37:47 cronus:~/src/illumos/docs$ mkdocs serveINFO    -  Building documentation...INFO    -  Cleaning site directory[I 180302 19:37:52 server:283] Serving on http://127.0.0.1:8000[I 180302 19:37:52 handlers:60] Start watching changes[I 180302 19:37:52 handlers:62] Start detecting changes

Runmkdocs gh-deploy from the repository root to deploy to GitHub Pages. Themkdocs documentation on this command ishere.

Additions or updates should be submitted via Pull Request.

If you notice any problems, but don't feel like you want to fix them yourself,please open anissue.