Skip to content

A version of pmarsceil's just-the-docs theme, modified for my personal use.

License

Notifications You must be signed in to change notification settings

RMWinslow/JTD-RMW

Repository files navigation

This is an extensively modified version of Patrick Marsceill's Just the Docs Jekyll theme.

I've heavily modified it, both to make it more suited for my purposes, and as a learning experience.

Header Arguments:

parent: Title of Parent : Nest this page with the title "Title of Parent" in the navigation menus. Note that unlike the original Jekyll, I don't check for grand_parent title. (Maybe I should check the grandparent if one is present.)

has_toc: false : Parent pages usually list their children after the main content. This disables that automatically generated list of children.

date and last_modified_date : Self explanatory. Use YYYY-MM-DD format.

layout: post : Use the layout with my additions, namely: ToC, subtitle, date in header.

toc: true : My addition which adds a collapsible table of contents to the page, using jekyll-toc. Only works with layout: post.

description : Adds a manual description to SEO headers and some of my navigation menus.

nav_exclude : renders the page but hides it from the sidebar and parent TOCs

search_exclude : makes the page invisible to the search widget

table_wrappers: to toggle two alternate ways of wrapping the tables.

  • table_wrappers: false disables the table wrappers entirely. Bare tables.
  • table_wrappers: wide makes the table wrapper span the entire width of the page, and doesn't widen the tables inside. May play oddly with asides.
  • Otherwise, the tablewrappers work as default in JTD.

About

A version of pmarsceil's just-the-docs theme, modified for my personal use.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published