ZEPL Documentation

1. Install Mkdocs

ZEPL Documentation is made by Mkdocs. So you need to install mkdocs. In order to install MkDocs, you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have these already installed like so: latest version of MkDocs supports Python 3.

$ python --version
Python 3.6.x

Install the mkdocs package using pip:

$ pip install -I mkdocs==1.0.4

Or, use virtualenv:

virtualenv --python=/usr/local/bin/python3 ~/.virtualenvs/mkdocs
source ~/.virtualenvs/mkdocs/bin/activate
pip install -r requirements.txt
mkdocs build --clean
mkdocs gh-deploy
deactivate

2. Clone this repository

Just clone this repository.

3. How to add a new documentation page?

This is the directory structure of this repository.

    |-- zepl-documentation
    |   |-- docs
    |       |-- CNAME
    |       |-- css
    |       |-- js
    |       |-- img
    |       |-- favicon.ico
    |       |-- index.md
    |       |-- *.md
    |   |-- custom_theme
            |-- *.html
            |-- __init__.py
            |-- css
            |-- img
            |-- js
            |-- fonts
            |-- license
    |   |-- mkdocs.yml
    |   |-- README.md

• /mkdocs.yml : All of the configuration properties will be defined in this file. Navigation menu is defined in this file.
• /docs : Under this directory, css file, image files for docs and all of the .md files are located in this directory.
• /docs/CNAME : Using this file, you can define the domain name: http://docs.zepl.com.
• /docs/css/extra.css, /docs/js/extra.js : You can define extra CSS and javascript function in these directory.
• /docs/img/*.png : You can put all of the image file used for documentation files.
• /docs/favicon.ico : This file will make favicon image to the browser tab.
• /docs/index.md : index.md file will make Home Page of this site.
• /docs/*.md : All of the markdown(documentation) files will be located.
• /custom-theme/ : All of components related with site theme are located in this directory.
• /custom-theme/__init__.py : This python file helps this directory to be recognized as a part of this package.
• /custom-theme/*.html : All of the html files composing theme components are located.
• /custom-theme/css/*.css : If you want to customize theme, modify theme-extra.css file.
• /custom-theme/js/*.js : All of javascript files related with theme actions are located in this directory.

If you want to add a new file, just locate the new .md file under /docs and add some information about the docs to the mkdocs.yml.

4. Build and deploy your change

IMPORTANT: Read the section "Automatic deployment" first.

MkDocs comes with a built-in webserver that lets you preview your documentation as you work on it. Start the webserver by making sure you are in the same directory as the mkdocs.yml config file, and then running the mkdocs serve command:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

Then you can check your change in realtime at http://127.0.0.1:8000.

Before the deployment, build the site for making sure there is no errors. --clean option enables to remove any stale files.

$ mkdocs build --clean

After then, let's deploy it to ZEPL Documentation site.

$ mkdocs gh-deploy --clean

Check the final result at https://docs.zepl.com/

Automatic deployment

When merging code into master, it is automatically deployed to https://docs.zepl.com. The recommended way is to go through a pull request.

GA Tracking

• Tracking ID : UA-38575365-18
• Tracking Dashboard