Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eddywashere/jekyll-tldr

A jekyll documentation theme inspired by readthedocs and sphinx.
https://github.com/eddywashere/jekyll-tldr

Last synced: 25 days ago
JSON representation

A jekyll documentation theme inspired by readthedocs and sphinx.

Host: GitHub
URL: https://github.com/eddywashere/jekyll-tldr
Owner: eddywashere
License: mit
Created: 2014-09-01T19:52:54.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2014-09-01T20:04:48.000Z (about 10 years ago)
Last Synced: 2024-04-10T09:57:03.264Z (7 months ago)
Size: 125 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        jekyll-tldr

===========

A jekyll documentation theme inspired by readthedocs and sphinx.

Supports documentation via:

- standard pages with a psuedo sub nav based on section headings

- advanced pages organized via a docs collection (collections rendered in page or individual page), query by category, pseudo nav or nav with links to rendered docs

- nested navigation

- sub nav or table of contents with anchor links or links to collections

- sort nav by weight

- sort docs collection by name or weight

### Example Side Nav

- Standard (page)

    - ## heading (anchor)

        - ### sub heading (anchor)

    - ## heading (anchor)

- Advanced w/collection (page)

    - ## Collection Name 1 (anchor)

        - ### sub heading (anchor)

    - ## Collection Name 2 (anchor)

- Advanced w/collection Nested (page)

    - Collection Name 1 (page)

        - ## sub heading (anchor)

            - ### sub sub heading (anchor)

    - Collection Name 2(page)

        - ## sub heading (anchor)

### Notes

For now, the advanced page navigation has to be either anchor link based or linked based (collections are rendered as full html pages), and not a combination of the two. This is because a Collections output can only be set on `_config.yml` and not through the collection document via something like `published: false`. Tracking over at [jekyll/jekyll/issues/2863](https://github.com/jekyll/jekyll/issues/2863)