Welcome to MkDocs

For full documentation visit mkdocs.org.

Get it on gitlab-ci


pip install mkdocs-cordova-plugin


  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs help - Print this help message.

Project layout

mkdocs.yml                      # The configuration file.
    index.md                    # The documentation homepage.
    ...                         # Other markdown pages, images and other files.
cordova/index.js                # Apache Cordova Application logic (required)
cordova/templates/config.xml    # Apache Cordova Application global configuration file
cordova/templates/main.html     # Jinja2 Template for Apache Cordova
cordova/templates/package.json  # (optional; needed to publish template on npm)