├── .coveragerc ├── .gitattributes ├── .github └── workflows │ ├── checks.yml │ ├── docs.yml │ └── publish.yml ├── .gitignore ├── .python-version ├── LICENSE.md ├── README.md ├── docs ├── .nav.yml ├── extra.css ├── favicon.svg ├── features │ ├── .nav.yml │ ├── flattening.md │ ├── hiding.md │ ├── nav.md │ ├── options.md │ ├── sorting.md │ └── titles.md ├── index.md ├── migration-v3.md ├── philosophy.md └── reference.md ├── mkdocs.yml ├── mkdocs_awesome_nav ├── __init__.py ├── log.py ├── nav │ ├── __init__.py │ ├── config.py │ ├── context.py │ ├── directory.py │ ├── link.py │ ├── page.py │ ├── pattern.py │ ├── resolve.py │ └── section.py ├── plugin.py └── utils.py ├── pyproject.toml ├── tests ├── __init__.py ├── compatibility │ ├── __init__.py │ ├── mktheapidocs_test_module │ │ ├── mktheapidocs_test_module │ │ │ ├── __init__.py │ │ │ └── foo.py │ │ └── setup.py │ ├── test_exclude.py │ ├── test_material.py │ ├── test_mkdocs.py │ ├── test_mktheapidocs.py │ ├── test_monorepo.py │ ├── test_multirepo.py │ ├── test_static_i18n_folder.py │ └── test_static_i18n_suffix.py ├── conftest.py ├── examples │ ├── __init__.py │ ├── test_flattening.py │ ├── test_hiding.py │ ├── test_nav.py │ ├── test_sorting.py │ └── test_titles.py ├── test_config.py ├── test_flatten_single_child_sections.py ├── test_hide.py ├── test_ignore.py ├── test_nav.py ├── test_nav_directory.py ├── test_nav_file.py ├── test_nav_link.py ├── test_nav_pattern.py ├── test_nav_pattern_options.py ├── test_nav_section.py ├── test_plugin.py ├── test_sort_by.py ├── test_sort_direction.py ├── test_sort_ignore_case.py ├── test_sort_sections.py ├── test_sort_type.py ├── test_title.py └── test_use_index_title.py ├── tox.ini └── uv.lock /.coveragerc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/.coveragerc -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/checks.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/.github/workflows/checks.yml -------------------------------------------------------------------------------- /.github/workflows/docs.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/.github/workflows/docs.yml -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/.github/workflows/publish.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/.gitignore -------------------------------------------------------------------------------- /.python-version: -------------------------------------------------------------------------------- 1 | 3.13 2 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/LICENSE.md -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/README.md -------------------------------------------------------------------------------- /docs/.nav.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/.nav.yml -------------------------------------------------------------------------------- /docs/extra.css: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/extra.css -------------------------------------------------------------------------------- /docs/favicon.svg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/favicon.svg -------------------------------------------------------------------------------- /docs/features/.nav.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/features/.nav.yml -------------------------------------------------------------------------------- /docs/features/flattening.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/features/flattening.md -------------------------------------------------------------------------------- /docs/features/hiding.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/features/hiding.md -------------------------------------------------------------------------------- /docs/features/nav.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/features/nav.md -------------------------------------------------------------------------------- /docs/features/options.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/features/options.md -------------------------------------------------------------------------------- /docs/features/sorting.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/features/sorting.md -------------------------------------------------------------------------------- /docs/features/titles.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/features/titles.md -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/index.md -------------------------------------------------------------------------------- /docs/migration-v3.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/migration-v3.md -------------------------------------------------------------------------------- /docs/philosophy.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/philosophy.md -------------------------------------------------------------------------------- /docs/reference.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/docs/reference.md -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs.yml -------------------------------------------------------------------------------- /mkdocs_awesome_nav/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /mkdocs_awesome_nav/log.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/log.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/nav/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /mkdocs_awesome_nav/nav/config.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/nav/config.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/nav/context.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/nav/context.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/nav/directory.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/nav/directory.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/nav/link.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/nav/link.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/nav/page.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/nav/page.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/nav/pattern.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/nav/pattern.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/nav/resolve.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/nav/resolve.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/nav/section.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/nav/section.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/plugin.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/plugin.py -------------------------------------------------------------------------------- /mkdocs_awesome_nav/utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/mkdocs_awesome_nav/utils.py -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/pyproject.toml -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/compatibility/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/compatibility/mktheapidocs_test_module/mktheapidocs_test_module/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/compatibility/mktheapidocs_test_module/mktheapidocs_test_module/foo.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/mktheapidocs_test_module/mktheapidocs_test_module/foo.py -------------------------------------------------------------------------------- /tests/compatibility/mktheapidocs_test_module/setup.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/mktheapidocs_test_module/setup.py -------------------------------------------------------------------------------- /tests/compatibility/test_exclude.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/test_exclude.py -------------------------------------------------------------------------------- /tests/compatibility/test_material.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/test_material.py -------------------------------------------------------------------------------- /tests/compatibility/test_mkdocs.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/test_mkdocs.py -------------------------------------------------------------------------------- /tests/compatibility/test_mktheapidocs.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/test_mktheapidocs.py -------------------------------------------------------------------------------- /tests/compatibility/test_monorepo.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/test_monorepo.py -------------------------------------------------------------------------------- /tests/compatibility/test_multirepo.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/test_multirepo.py -------------------------------------------------------------------------------- /tests/compatibility/test_static_i18n_folder.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/test_static_i18n_folder.py -------------------------------------------------------------------------------- /tests/compatibility/test_static_i18n_suffix.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/compatibility/test_static_i18n_suffix.py -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/conftest.py -------------------------------------------------------------------------------- /tests/examples/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/examples/test_flattening.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/examples/test_flattening.py -------------------------------------------------------------------------------- /tests/examples/test_hiding.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/examples/test_hiding.py -------------------------------------------------------------------------------- /tests/examples/test_nav.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/examples/test_nav.py -------------------------------------------------------------------------------- /tests/examples/test_sorting.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/examples/test_sorting.py -------------------------------------------------------------------------------- /tests/examples/test_titles.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/examples/test_titles.py -------------------------------------------------------------------------------- /tests/test_config.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_config.py -------------------------------------------------------------------------------- /tests/test_flatten_single_child_sections.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_flatten_single_child_sections.py -------------------------------------------------------------------------------- /tests/test_hide.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_hide.py -------------------------------------------------------------------------------- /tests/test_ignore.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_ignore.py -------------------------------------------------------------------------------- /tests/test_nav.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_nav.py -------------------------------------------------------------------------------- /tests/test_nav_directory.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_nav_directory.py -------------------------------------------------------------------------------- /tests/test_nav_file.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_nav_file.py -------------------------------------------------------------------------------- /tests/test_nav_link.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_nav_link.py -------------------------------------------------------------------------------- /tests/test_nav_pattern.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_nav_pattern.py -------------------------------------------------------------------------------- /tests/test_nav_pattern_options.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_nav_pattern_options.py -------------------------------------------------------------------------------- /tests/test_nav_section.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_nav_section.py -------------------------------------------------------------------------------- /tests/test_plugin.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_plugin.py -------------------------------------------------------------------------------- /tests/test_sort_by.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_sort_by.py -------------------------------------------------------------------------------- /tests/test_sort_direction.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_sort_direction.py -------------------------------------------------------------------------------- /tests/test_sort_ignore_case.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_sort_ignore_case.py -------------------------------------------------------------------------------- /tests/test_sort_sections.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_sort_sections.py -------------------------------------------------------------------------------- /tests/test_sort_type.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_sort_type.py -------------------------------------------------------------------------------- /tests/test_title.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_title.py -------------------------------------------------------------------------------- /tests/test_use_index_title.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tests/test_use_index_title.py -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/tox.ini -------------------------------------------------------------------------------- /uv.lock: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lukasgeiter/mkdocs-awesome-nav/HEAD/uv.lock --------------------------------------------------------------------------------