Skip to content

migrating from awesome-pages: the .nav.yml is not loaded if using same dir root instead of docs folder #130

@anb0s

Description

@anb0s

I'm migrating from awesome-pages and have replaced to this plugin and now miss something to have the new .nav.yml loaded from the root directory, because using same-dir plugin and docs_dir: "." instead of docs/.

How to configure it? I've placed the file .nav.yml to the root and also to a subfolder docs/ but it looks like nav: is not loaded

# replaced navigation with plugin: https://lukasgeiter.github.io/mkdocs-awesome-nav/migration-v3/#nav_1

# https://lukasgeiter.github.io/mkdocs-awesome-nav/features/flattening/
flatten_single_child_sections: true
nav:
- Overview: 'README.md'
- 'Content-Demo':
  - "docs/**/*"
- 'Doxygen-Demo':
  - 'Links': 'doxygen-demo/links.md'
  - 'Classes':
    - 'Class List': 'doxygen-demo/annotated.md'
    - 'Class Index': 'doxygen-demo/classes.md'
    - 'Class Hierarchy': 'doxygen-demo/hierarchy.md'
    - 'Class Members': 'doxygen-demo/class_members.md'
    - 'Class Member Functions': 'doxygen-demo/class_member_functions.md'
    - 'Class Member Variables': 'doxygen-demo/class_member_variables.md'
    - 'Class Member Typedefs': 'doxygen-demo/class_member_typedefs.md'
    - 'Class Member Enumerations': 'doxygen-demo/class_member_enums.md'
  - "Namespaces":
    - "Namespace List": "doxygen-demo/namespaces.md"
    - "Namespace Members": "doxygen-demo/namespace_members.md"
    - "Namespace Member Functions": "doxygen-demo/namespace_member_functions.md"
    - "Namespace Member Variables": "doxygen-demo/namespace_member_variables.md"
    - "Namespace Member Typedefs": "doxygen-demo/namespace_member_typedefs.md"
    - "Namespace Member Enumerations": "doxygen-demo/namespace_member_enums.md"
  - "Functions": "doxygen-demo/functions.md"
  - "Variables": "doxygen-demo/variables.md"
  - "Macros": "doxygen-demo/macros.md"
  - "Files": "doxygen-demo/files.md"
  - "Pages": "doxygen-demo/pages.md"
  - "modules": "doxygen-demo/modules.md"
- 'Changelog': 'CHANGELOG.md'
- 'Contributing': 'CONTRIBUTING.md'
- 'License':
  - 'CHECKLIST.md'
  - 'LICENSE.md'
  - 'COPYING.md'
- 'Tags': 'tags.md'

folder structure:

docs
  |_badges.md
  |_caption.md
  |_cards.md
  |_diagrams.md
  |_...
doxygen-demo
  |_links.md
  |_ ...
CHANGELOG.md
CHECKLIST.md
CONTRIBUTING.md
COPYING.md
README.md
tags.md
mkdocs.yml
.nav.yml

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions