Skip to content

Contribute to Documents

XMUX Help Center is powered by mkdocs with its themes and plugins.

Prerequisite

  • Markdown
  • Github Account
  • Basic operations of Git repository.
  • Installation of Python 3 and Python packages.

Note

The last prerequisite is required only when you want to set up a local environment.

Local Environment Setup

  1. Install Python 3.

  2. Install following Python packages.

    • mkdocs
    • mkdocs-material
    • pygments

    Which usually can be done by pip3 install mkdocs mkdocs-material pygments or conda install -c conda-forge mkdocs mkdocs-material if you are using conda.

  3. Clone repository of documents.

    git clone https://github.com/XMUMY/docs

  4. Start a local server.

    cd docs
mkdocs serve

    The document website should be able for visiting through http://127.0.0.1:8000