Home

Welcome to the mxchandbook wiki!

Here you can find the developer guidelines and explanations.

How is the handbook build

The handbook is using a modified version of the Docsify framework.

Why?

• No statically built html files
• Simple and lightweight
• Smart full-text search plugin
• Multiple themes
• Useful plugin API
• Emoji support
• Compatible with IE11
• Support server-side rendering (example)

Quick start

It is recommended to install docsify-cli globally, which helps initializing and previewing the website locally.

npm i docsify-cli -g

Preview the handbook

Run the local server with docsify serve. You can preview your site in your browser on http://localhost:3000.

docsify serve docs

main structure

• index.html as the entry file
• README.md as the home page
• .nojekyll prevents GitHub Pages from ignoring files that begin with an underscore