Giter Club home page Giter Club logo

mkdocs-torillic's Introduction

Torillic

Magic is distilled laziness

This theme, named after the fantasy setting of Dungeons & Dragons, is designed with tabletop RPG players in mind. The theme allows beautiful HTML exports designed to look like a professionally made tabletop resource, whilst remaining easy to edit in code view and in small windows, thanks to CSS media queries.

Theme configuration

Torillic accepts the following theme configuration options in the mkdocs.yaml file:

background_image

Supply either a file path or a web link to an image to use for the site's background. If not supplied, will use the defaut Torillic background (wood planks).

Page configuration

Torillic accepts the following configuration options from an individual page's yaml frontmatter:

contents

Whether to include a contents block and, if so, what kind. Options are:

  • global: Include a "global" contents block, i.e. one which describes the entire site
  • local: Include a local contents block, i.e. one which describes the current page's children / siblings
  • none: Do not include a contents block

If not supplied, the site homepage will have global contents block and section home pages will have a local contents block, other pages will not include a contents block.

Tips & Tricks

  • Using > blockquotes will create a green box like the ones used in 5e stat blocks
  • In full page view, content is arranged into two columns - however, # heading 1 and # heading 2 elements span both columns so can be used as separators. A blank top-level heading will still split the page.
  • The heading with a yellow line underneath (you know the one) is #### heading 4
  • Actions in 5e stat blocks are generally formatted like so:
***Name.*** *Attack Type:* +[modifier] to hit, reach [reach] ft., [n targets] target(s). *Hit:* [approx damage] ([n dice]d[die size] + [additional]) [damage type] damage.
  • For an example of a full stat sheet in Torillic, check out the markdown below the screenshots.
  • Ultimately, it's yours to play with, so feel free to completely ignore this advice and lay things out however works for your campaign!

mkdocs-torillic's People

Contributors

teparsons avatar jwsy avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

jwsy

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.