Comments (7)
Discussed with @aslakhellesoy today:
- TOC should distinguish between level of headers. (Example we looked at: http://kotlinlang.org/docs/tutorials/ - folding in and out is not necessary, also longer pages are fine but should have "jump to" TOC)
- TOC should not be "lost" when scrolling down, especially if we're making longer pages (i.e. Cucumber reference)
- Very short pages may not need TOC (e.g. install page?); possibly be able to turn off/on TOC for a page in the frontmatter
Sidenote: TOC doesn't work when inside of language block
from docs.
Sounds good. I'm looking at implementing stickiness on the menu.
I think the solution to the language blocks is to remove all titles from them. @aslakhellesoy is writing a linter for that, and we can then fix it.
I'll look into multi level TOC, not sure it works out of the box.
from docs.
If by removing titles from language blocks you mean make sure they're outside of the language block, then yeah!
Note: There might be titles that are only relevant inside a language block though? I.e. Maven for Java, npm for Javascript, bundler for Ruby. Sections should have a high level title outside the language block, i.e. build tools or something, but language specifics inside the block.
from docs.
Yeah, making sure they're outside.
We can probably write around most cases, although the ones you mention might be tricky
from docs.
Make them bold instead of headers?
from docs.
Also, see #108 (and maybe merge these issues?)
from docs.
Fixed in 9e2f8b4
from docs.
Related Issues (20)
- Archetype without running tests with maven integration HOT 1
- Online documentation is broken and unreadable HOT 9
- Use Renovate to update versions.yaml
- Docs website formatting is broken HOT 24
- The API reference page is broken in production, half of the content missing HOT 2
- New unofficial golang implementation HOT 6
- Update direct links to docs on Cucumber website
- Move the 10-minute-tutorial(s) to source code and enable running them in a pre-built environments
- Netlify preview keeps spamming cookie warnings
- Books "Card" embed logic breaks the page HOT 1
- Python Cucumber: Is there a Behave replacement? HOT 2
- Json Cucumber mergeFeaturesWithRetest HOT 1
- Ctrl+C does not stop/kill Docker running the docs HOT 2
- Consistent and correct spelling
- How to enable test data externalization (through Excel/JSON etc.) using Cucumber Java and TestNG? HOT 1
- Can I decide whether the following steps should continue to execute based on the result of the previous step execution HOT 1
- Step of installing cucumber as dependency should be required for the 10 Minute Tutorial
- Add definition of glue to docs HOT 1
- Automate gherkin-i18n-table based on json of gherkin repo HOT 5
- Question for Background with Feature and Rule HOT 4
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.