Giter VIP home page Giter VIP logo

Comments (8)

lukasgeiter avatar lukasgeiter commented on June 5, 2024 1

Good news! I did some quick tests and should be possible. Here's how it's going to work:

If a ... entry is present, the plugin generates a second navigation tree based off the file structure. All pages explicitly mentioned in nav are removed from this navigation tree before it is inserted in place of the ... entry.

It's going to take me a bit of time to properly implement and test this. I'll let you know once the release is out.

from mkdocs-awesome-pages-plugin.

lukasgeiter avatar lukasgeiter commented on June 5, 2024

Restructuring your docs actually sounds like a good idea to me. Can you help me understand why you don't want to go that route?
Of course I understand that there is some work involved, but I would think that it should be quite easy to move a few files into folders and update any links if necessary. Plus you'll end up with a better organized file structure.

from mkdocs-awesome-pages-plugin.

athal7 avatar athal7 commented on June 5, 2024

Users have bookmarked some of the pages, and Iโ€™m not 100% sure this is the final organization, so I donโ€™t want to setup redirects potentially multiple times

from mkdocs-awesome-pages-plugin.

athal7 avatar athal7 commented on June 5, 2024

Looking at trying to implement this, I can see why there's some hesitation @lukasgeiter :). Some abstractions in the test setup around asserting section children have the section as the parent and some of the assumptions in MetaNavItem may make this request challenging to fulfill.

from mkdocs-awesome-pages-plugin.

lukasgeiter avatar lukasgeiter commented on June 5, 2024

The implementation is only part of why I'm hesitant. Your request somewhat goes against the core idea of the .pages file. Which is configuring the navigation at the folder level.

I think a better idea for you might be to add support for an ... entry to nav in mkdocs.yml. I'll look into the feasibility of such a feature and get back to you soon.

from mkdocs-awesome-pages-plugin.

athal7 avatar athal7 commented on June 5, 2024

good thinking, and thanks!

from mkdocs-awesome-pages-plugin.

lukasgeiter avatar lukasgeiter commented on June 5, 2024

I've just released v2.4.0 with this feature. Check out the updated README for all the details.

from mkdocs-awesome-pages-plugin.

athal7 avatar athal7 commented on June 5, 2024

Works great, thank you @lukasgeiter!

from mkdocs-awesome-pages-plugin.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.