Giter Club home page Giter Club logo

just-the-docs-tweaked's Introduction

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

just-the-docs-tweaked's People

Contributors

bmann avatar codesandwich avatar daviddarnes avatar dependabot-preview[bot] avatar dependabot-support avatar ericfromcanada avatar flut1 avatar fogfish avatar folbert avatar gebeto avatar ghabs avatar gnarea avatar hvianna avatar iamcarrico avatar jakebresnehan avatar joesb avatar kasparetter avatar mattxwang avatar nergmada avatar pdebruic avatar pdmosses avatar phillipcutter avatar plancomps-admin avatar pmarsceill avatar r-brown avatar rmwinslow avatar roiarthurb avatar sgtsilvio avatar stefanoborini avatar woernfl avatar

Watchers

 avatar

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.