Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Bryan Horstmann-Allen
Bryan Horstmann-Allen Note on markdown extensions
Latest commit 105119a Apr 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
material-illumos fix: nav items nest weirdly when storing url in element Mar 10, 2019
.gitignore Initial commit, testing skel. Feb 23, 2018
LICENSE
README.md
mkdocs.yml

README.md

illumos.org

This repository contains markdown for illumos.org. It is written in mkdocs.

We are using a customized version of the material theme.

Contributing

If you're looking to help out but aren't sure where to start, please have a look at our open issues.

Markdown Formatting

We have a number of Markdown extensions installed. See the mkdocs.yml file's markdown_extensions section for a list.

Their documentation can be found here.

Installing mkdocs

mkdocs is written in Python. Please see their instructions for details, but the short of it is:

pip install mkdocs
pip install mkdocs-material
pip install markdown-include

Testing changes

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

Assuming you have mkdocs installed, you can simply do mkdocs serve to start a local test server.

19:37:47 cronus:~/src/illumos/docs$ mkdocs serve
INFO    -  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

Deploying changes

Run mkdocs gh-deploy from the repository root to deploy to GitHub Pages. The mkdocs documentation on this command is here.

Submitting changes

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 an issue.

You can’t perform that action at this time.