Skip to content

Testing Locally

You might want to test your documentation locally before pushing it to your repository.

Install mkdocs with

1
pip install mkdocs-material

After generating the docs with mdsplit, run the mkdocs server with

1
mkdocs serve

Or build the static documentation with

1
mkdocs serve

Use this mkdocs configuration file to get started:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
site_name: mdsplit
site_url: https://alandefreitas.github.io/mdsplit/
repo_url: https://github.com/alandefreitas/mdsplit
repo_name: alandefreitas/mdsplit

site_description: Generate documentation from bulky README.md files

theme:
  name: material
  palette:
    scheme: preference
  features:
    - navigation.instant
    - navigation.sections
    - toc.integrate
    - header.autohide
  icon:
    repo: fontawesome/brands/git-alt

edit_uri: ""

plugins:
  - search
  - awesome-pages # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin

google_analytics:
  - G-3H1KP9L0TN
  - auto

copyright: Copyright © 2020 Alan Freitas

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true
      linenums: true
      linenums_style: pymdownx.inline
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - meta

extra_javascript:
  - javascripts/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

Replace the settings with your repository information.