├── .github ├── FUNDING.yml └── workflows │ ├── autofix.yml │ ├── ci.yml │ ├── deploy-docs.yml │ └── deploy-release.yml ├── .gitignore ├── .tools ├── copier-answers.yml └── release.sh ├── LICENSE.md ├── README.md ├── docs ├── README.md └── reference.md ├── mkdocs.yml ├── mkdocs_literate_nav ├── __init__.py ├── exceptions.py ├── parser.py ├── plugin.py └── py.typed ├── pyproject.toml ├── requirements ├── requirements-docs.txt └── requirements-style.txt └── tests ├── conftest.py ├── nav ├── hybrid │ ├── test_empty.yml │ ├── test_files_in_subsection.yml │ ├── test_flattened_files_in_subsection.yml │ ├── test_from_readme.yml │ ├── test_keeps_original_nav.yml │ ├── test_literate_in_subsection.yml │ ├── test_nav_and_literate.yml │ ├── test_preserves_url.yml │ ├── test_repeated.yml │ ├── test_slash_with_nav.yml │ ├── test_very_nested.yml │ └── test_wildcard_slash.yml ├── nested │ ├── test_basic.yml │ ├── test_borgs.yml │ ├── test_dir_without_slash.yml │ ├── test_go_up.yml │ ├── test_go_up_too_much.yml │ ├── test_implicit_index_as_nav.yml │ ├── test_implicit_index_borgs.yml │ ├── test_missing.yml │ ├── test_nested.yml │ ├── test_recursion.yml │ └── test_repeated.yml ├── test_basic.yml ├── test_broken_before_marker.yml ├── test_element_after.yml ├── test_empty.yml ├── test_empty_section.yml ├── test_fancy_link.yml ├── test_multiple_nav.yml ├── test_multiple_nav_and_others.yml ├── test_multiple_unmarked_nav.yml ├── test_nav_after_gap.yml ├── test_nav_last.yml ├── test_no_title.yml ├── test_obscured_link.yml ├── test_obscured_section.yml ├── test_preserves_url.yml ├── test_section_with_link.yml ├── test_special_chars.yml ├── test_text_after.yml └── wildcard │ ├── test_basic.yml │ ├── test_dirs_then_files.yml │ ├── test_from_readme.yml │ ├── test_implicitly_recursive.yml │ ├── test_multidir_file.yml │ ├── test_no_files.yml │ ├── test_no_repeat_with_directory.yml │ ├── test_non_matching.yml │ ├── test_omits_competing_parent_first.yml │ ├── test_omits_competing_subdir_first.yml │ ├── test_omits_in_subdir.yml │ ├── test_omits_in_superdir.yml │ ├── test_skips_nav_file.yml │ └── test_wildcard_under_index.yml └── test_plugin.py /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: oprypin 2 | -------------------------------------------------------------------------------- /.github/workflows/autofix.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/.github/workflows/autofix.yml -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/.github/workflows/ci.yml -------------------------------------------------------------------------------- /.github/workflows/deploy-docs.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/.github/workflows/deploy-docs.yml -------------------------------------------------------------------------------- /.github/workflows/deploy-release.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/.github/workflows/deploy-release.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/.gitignore -------------------------------------------------------------------------------- /.tools/copier-answers.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/.tools/copier-answers.yml -------------------------------------------------------------------------------- /.tools/release.sh: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/.tools/release.sh -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/LICENSE.md -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/README.md -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | --8<-- "README.md" 2 | -------------------------------------------------------------------------------- /docs/reference.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/docs/reference.md -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/mkdocs.yml -------------------------------------------------------------------------------- /mkdocs_literate_nav/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = "0.6.2" 2 | -------------------------------------------------------------------------------- /mkdocs_literate_nav/exceptions.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/mkdocs_literate_nav/exceptions.py -------------------------------------------------------------------------------- /mkdocs_literate_nav/parser.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/mkdocs_literate_nav/parser.py -------------------------------------------------------------------------------- /mkdocs_literate_nav/plugin.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/mkdocs_literate_nav/plugin.py -------------------------------------------------------------------------------- /mkdocs_literate_nav/py.typed: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/pyproject.toml -------------------------------------------------------------------------------- /requirements/requirements-docs.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/requirements/requirements-docs.txt -------------------------------------------------------------------------------- /requirements/requirements-style.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/requirements/requirements-style.txt -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/conftest.py -------------------------------------------------------------------------------- /tests/nav/hybrid/test_empty.yml: -------------------------------------------------------------------------------- 1 | files: {} 2 | output: [] 3 | -------------------------------------------------------------------------------- /tests/nav/hybrid/test_files_in_subsection.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_files_in_subsection.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_flattened_files_in_subsection.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_flattened_files_in_subsection.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_from_readme.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_from_readme.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_keeps_original_nav.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_keeps_original_nav.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_literate_in_subsection.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_literate_in_subsection.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_nav_and_literate.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_nav_and_literate.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_preserves_url.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_preserves_url.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_repeated.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_repeated.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_slash_with_nav.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_slash_with_nav.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_very_nested.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_very_nested.yml -------------------------------------------------------------------------------- /tests/nav/hybrid/test_wildcard_slash.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/hybrid/test_wildcard_slash.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_basic.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_basic.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_borgs.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_borgs.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_dir_without_slash.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_dir_without_slash.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_go_up.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_go_up.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_go_up_too_much.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_go_up_too_much.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_implicit_index_as_nav.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_implicit_index_as_nav.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_implicit_index_borgs.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_implicit_index_borgs.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_missing.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_missing.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_nested.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_nested.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_recursion.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_recursion.yml -------------------------------------------------------------------------------- /tests/nav/nested/test_repeated.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/nested/test_repeated.yml -------------------------------------------------------------------------------- /tests/nav/test_basic.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_basic.yml -------------------------------------------------------------------------------- /tests/nav/test_broken_before_marker.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_broken_before_marker.yml -------------------------------------------------------------------------------- /tests/nav/test_element_after.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_element_after.yml -------------------------------------------------------------------------------- /tests/nav/test_empty.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_empty.yml -------------------------------------------------------------------------------- /tests/nav/test_empty_section.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_empty_section.yml -------------------------------------------------------------------------------- /tests/nav/test_fancy_link.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_fancy_link.yml -------------------------------------------------------------------------------- /tests/nav/test_multiple_nav.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_multiple_nav.yml -------------------------------------------------------------------------------- /tests/nav/test_multiple_nav_and_others.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_multiple_nav_and_others.yml -------------------------------------------------------------------------------- /tests/nav/test_multiple_unmarked_nav.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_multiple_unmarked_nav.yml -------------------------------------------------------------------------------- /tests/nav/test_nav_after_gap.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_nav_after_gap.yml -------------------------------------------------------------------------------- /tests/nav/test_nav_last.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_nav_last.yml -------------------------------------------------------------------------------- /tests/nav/test_no_title.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_no_title.yml -------------------------------------------------------------------------------- /tests/nav/test_obscured_link.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_obscured_link.yml -------------------------------------------------------------------------------- /tests/nav/test_obscured_section.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_obscured_section.yml -------------------------------------------------------------------------------- /tests/nav/test_preserves_url.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_preserves_url.yml -------------------------------------------------------------------------------- /tests/nav/test_section_with_link.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_section_with_link.yml -------------------------------------------------------------------------------- /tests/nav/test_special_chars.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_special_chars.yml -------------------------------------------------------------------------------- /tests/nav/test_text_after.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/test_text_after.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_basic.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_basic.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_dirs_then_files.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_dirs_then_files.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_from_readme.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_from_readme.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_implicitly_recursive.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_implicitly_recursive.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_multidir_file.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_multidir_file.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_no_files.yml: -------------------------------------------------------------------------------- 1 | files: 2 | SUMMARY.md: | 3 | - * 4 | output: [] 5 | -------------------------------------------------------------------------------- /tests/nav/wildcard/test_no_repeat_with_directory.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_no_repeat_with_directory.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_non_matching.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_non_matching.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_omits_competing_parent_first.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_omits_competing_parent_first.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_omits_competing_subdir_first.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_omits_competing_subdir_first.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_omits_in_subdir.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_omits_in_subdir.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_omits_in_superdir.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_omits_in_superdir.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_skips_nav_file.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_skips_nav_file.yml -------------------------------------------------------------------------------- /tests/nav/wildcard/test_wildcard_under_index.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/nav/wildcard/test_wildcard_under_index.yml -------------------------------------------------------------------------------- /tests/test_plugin.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oprypin/mkdocs-literate-nav/HEAD/tests/test_plugin.py --------------------------------------------------------------------------------