Comments (8)
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.
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.
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.
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.
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.
good thinking, and thanks!
from mkdocs-awesome-pages-plugin.
I've just released v2.4.0 with this feature. Check out the updated README for all the details.
from mkdocs-awesome-pages-plugin.
Works great, thank you @lukasgeiter!
from mkdocs-awesome-pages-plugin.
Related Issues (20)
- [BUG] HOT 1
- Is it possible to hide a single file from nav? HOT 8
- issue with material for mkdocs when using navigation.prune HOT 3
- folder level .pages nav not working when top level .pages nav has sub-sections? HOT 2
- Installation was successful, but MKDOCS server spits out the error "plugin is not installed" HOT 11
- Version 2.9.2 regression in `.pages` handling HOT 3
- support for imported repositories (multirepo plugin) HOT 5
- Can nav be sorted by date? HOT 3
- Ordering breaks when rest pattern is used in mkdocs > nav HOT 7
- conda-forge distribution
- Full custom nav for pages in a directory HOT 1
- Deep `.pages.` files not respected HOT 3
- does not work in combination with monorepo HOT 6
- Possible to build full nav in directory? HOT 4
- An absolute path to '/...' is included in the 'nav' configuration, which presumably points to an external HOT 6
- Hide pages but still show left navigation? HOT 2
- Order does not take effect for subdirectory files HOT 2
- Possible regression in 2.9.2: `hide: true` not working in `.pages` HOT 3
- Custom styling on nav items HOT 2
- [FEATURE] `flat n` - How to include nested folders correctly? HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mkdocs-awesome-pages-plugin.