Git Product home page Git Product logo

Comments (7)

mlvandijk avatar mlvandijk commented on July 28, 2024

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.

plaindocs avatar plaindocs commented on July 28, 2024

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.

mlvandijk avatar mlvandijk commented on July 28, 2024

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.

plaindocs avatar plaindocs commented on July 28, 2024

Yeah, making sure they're outside.

We can probably write around most cases, although the ones you mention might be tricky

from docs.

mlvandijk avatar mlvandijk commented on July 28, 2024

Make them bold instead of headers?

from docs.

mlvandijk avatar mlvandijk commented on July 28, 2024

Also, see #108 (and maybe merge these issues?)

from docs.

plaindocs avatar plaindocs commented on July 28, 2024

Fixed in 9e2f8b4

from docs.

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.