Comments (6)
I would not recommend putting the table of content inside the navbar as it is already pretty crowded.
Also I think separating both would make more sense.
In you discord.py documentation example, the layout is different as we have much more pages and a navigation drawer.
Electron documentation is much closer to what we have (https://www.electronjs.org/docs/latest/tutorial/installation) and it doesn't affect the read quality.
from docs.
I suppose? but I feel like Faithful applies more to the discord.py example since we have much more complicated articles with a lot of nested headings, plus the sidebar is used a lot more effectively here than on the faithful docs site where you pretty much only use it to switch to completely unrelated articles rather than here where it seems like you're going through a tutorial on how to use the program and would keep going down the list on the left
from docs.
Okay, you're right. Would you like to load all tables of contents in nav or just the currently loaded page? All tables of content may be difficult
from docs.
every article having a visible dropdown at once would be nice if that's not too difficult, but I understand your concerns and would be fine with having just the currently loaded page have the table of contents opened
from docs.
just found the linux kernel docs have pretty much exactly the same setup that I'm asking for, including category titles etc
https://www.kernel.org/doc/html/v4.10/process/development-process.html
it only shows top-level headings on the sidebar which I quite like — we could just grab all h1 elements and display those titles on the left bar
also, I really like how the table of contents is both present at the start of the article and on the sidebar — if you want each subpoint carefully listed out you can go to the top of the article but you can go to the main talking points anywhere in the article
from docs.
completed with #24
from docs.
Related Issues (15)
- [BUG] Marking an article as deprecated does literally nothing HOT 2
- [BUG] Links in table of contents don't scroll the screen far enough. HOT 4
- Build times for the docs site are really slow compared to every other faithfulpack.net site HOT 5
- [Feature] Add issue templates
- [Feature] Add an "archived" tag HOT 1
- [Features] Improve the navigation bar HOT 5
- [Feature] Use the stone background on the docs page rather than a plain background HOT 3
- Site build time is abnormally long HOT 6
- [Bug] 404 page doesn't use a transparent footer. HOT 2
- [Bug] Entire pages are off-center in specific scenarios. HOT 1
- [Bug] Footer in light mode uses incorrect text color
- [Long-term] VitePress rewrite
- Remove bot commands from Docs HOT 2
- API Docs HOT 2
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 docs.