Skip to main content

A simple mkdocs plugin, enable to sort nav by setting "weight" in markdown metadata

Project description

mkdocs-nav-weight

A simple mkdocs plugin, enable to sort nav by setting "weight" in markdown metadata
Not sure if it works (at least it does in my local docs). Only the compatibility of section, index and page has been considered.
mkdocs get nav first, and then reads markdown resource to page, so using this plugin means reading markdown source twice, which may introduce performance problems

Install

pip install mkdocs-nav-weight

mkdocs.yml

plugins:
  - search
  - mkdocs-nav-weight

Intro

Markdown metadata like this:

foo.md
---
title: foo
weight: 4
...
---

In the following, it is simply expressed as:

foo.md // 4

A document tree like this:

  bar.md // no “weight”
  foo.md // 4

├─have_index_folder
    another.md // 1
    index.md // 3
  
  └─level2
          another.md // 1
          bar.md  // no “weight”
          foo.md  // 4

└─no_index_folder
        alone.md // 2

You will get a nav like this:

bar  // 0: no 'weight', default 0
No index folder  // 0: cann't find a 'index', so it's defalut 0
	alone  // 2
Have index folder  // 3: get from 'index'
	index  // 0: it's 3 but as 0 in same level
    	Level2 // 0: no index, default 0
		bar // 0
		another // 1
		foo // 4
	another  // 1
foo  // 4

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-nav-weight-0.0.2.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_nav_weight-0.0.2-py3-none-any.whl (3.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page