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/just-the-docs-tweaked

 
 

Repository files navigation

This is a tweaked version of the "Just the Docs" theme for Github Pages.

I make the following changes to customize it for my own use:

  • css changes
    • stylesheet is now static .css instead of sass
    • color scheme is handled via css variables, and changed to a solarized-style color scheme.
    • deleted a bunch of the JTD utility classes that I don't need.
    • changed font properties so diacritics are rendered properly
    • added styling so that <aside> elements are placed in the page margins on wide screens
    • replaced the definition list styling with the styling Mozilla uses as an example here.
    • removed some annoying css overengineering:
      • Unordered lists just use the default rendering instead of the convoluted JTD thing where the bullet points are removed then replaced.
      • The default ordered-list numbering has been reinstated as well.
      • links (<a> elements) don't have wordwrap turned off. (why?!)
    • Changed the svg icons in the headers to use the link emoji instead of a link svg. That makes it easier to copy the page's contents into other blogging software.
    • support for subtitle/tagline in hgroup under h1
  • Removed the footer
  • added latex rendering with katex
  • toggled off html compression
  • changed main-content div to be a main element instead. Same display properties, but more semantically meaningful.
  • added a posts layout, since I'm using this template as a non-chronological pseudo-blog instead of as a docuementation subsite
    • posts layout includes the yaml date and last_modified_date under the post title
    • yaml option toc: true which puts a table of contents in the sidebar at the top of the page.
    • yaml subtitle placed as paragraph inside element under

      element

About

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • SCSS 34.5%
  • CSS 29.7%
  • HTML 20.6%
  • JavaScript 10.8%
  • Ruby 4.0%
  • Liquid 0.2%
  • Other 0.2%