
Security News
Vite Releases Technical Preview of Rolldown-Vite, a Rust-Based Bundler
Vite releases Rolldown-Vite, a Rust-based bundler preview offering faster builds and lower memory usage as a drop-in replacement for Vite.
A simple mkdocs plugin, enables to organize Navigation in a more markdownic way.
A simple mkdocs plugin, enables to organize Navigation in a more markdownic way.
This plugin tries to read markdown resources before mkdocs, which may add some performance overhead on building.
Four additional keys can be configured in Markdown Metadata ( also known as "front-matter", see metadata).
weight: number
-1
, 2.3
..., if unset, it goes 0
.weight
in an index
will be offered to its parent section
, there is a fixed value for itself, and the value is configurable, see: index_weight
.headless: bool
true
or false
, if unset, it goes false
.headless: true
will be hidden from nav, but these contents will still be rendered and accessible via URL.headless
in an index
will be offered to its parent section
.For index
only:
retitled: bool
true
or false
, if unset, it goes false
.section_renamed
which only applies this index
's title to its parent section
, it only works when section_renamed
is false
.empty: bool
true
or false
, if unset, it goes false
.index
only used to offer metadata for its parent section
and without any meaningful content, setting empty
to true
can help you to hide this index
itself.Install with pip
:
pip install mkdocs-nav-weight
Add the following lines to mkdocs.yml
plugins:
- search
- mkdocs-nav-weight
Configure in mkdocs.yml
:
plugins:
- search
- mkdocs-nav-weight:
section_renamed: false
index_weight: -10
warning: true
reverse: false
headless_included: false
section_renamed
Default: false
:
If true
, section name will use the title
of its index
instead of the folder name.
For compatibility we have to name a folder like "C#" as "CSharp", but what we actually want is "C#" , that's what this option does
index_weight
Default: -10
:
weight
value for index
itself, to ensure it's always the first at the same levelwarning
Default: true
:
Warning
when invalid values are detected in markdown metadatareverse
Default: false
:
true
, sort nav by weight
from largest to smallest.headless_included
Default: false
:
An option to control whether headless
pages should be included in nav.pages
which is used by some plugins, eg: mkdocs-pdf-export-plugin.
If true
, headless
pages will be included.
FAQs
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Vite releases Rolldown-Vite, a Rust-based bundler preview offering faster builds and lower memory usage as a drop-in replacement for Vite.
Research
Security News
A malicious npm typosquat uses remote commands to silently delete entire project directories after a single mistyped install.
Research
Security News
Malicious PyPI package semantic-types steals Solana private keys via transitive dependency installs using monkey patching and blockchain exfiltration.