dark_minimal_dirtree

Example

!!! Why this repo is archived

I did this project to understand how to customize mkdocs. This is a sort of stable, minimal and working solution that everyone can use as starting point to create their custom themes.

For more features I'll commit to this repo:

dark_enhanced_dirtree

links

• python repo
• github

installation

pip install mkdocs-dark-minimal-dirtree
python -m mkdocs new proj1
code proj1/
nano mkdocs.yml

site_name: My Docs
theme:
  name: dark_minimal_dirtree

python -m mkdocs serve

How it works

Everything that contains a markdown file inside the docs directory is listed in the navigation menu on the left. The order is by filename and not by title. This is good because you can name every file like:

• index.md
• 000.md
• dir1
  • 000.md
  • 001.md

But you can always change title as you want:

• index.md (Home)
• 000.md (part1)
• dir1
  • 000.md (part2)
  • 001.md (part3)

Resulting in:

• Home
• part1
• dir1 (this is collapsable)
  • part2
  • part3

How to customize this theme

1. Go here and download the .tar.gz file

2. Create a new project with python -m mkdocs new proj

3. Extract dark_minimal_dirtree inside the project:

   docs
   	index.md
   mkdocs.yml
   dark_minimal_dirtree

4. Edit the mkdocs.yml file

   site_name: My Docs
   theme:
   	name: null
   	custom_dir: dark_minimal_dirtree