Tabletop Simulator documentation.
Clone or download
Latest commit 73246bc Dec 15, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Update chat-rules.md Dec 15, 2018
theme/partials Initial Commit Oct 20, 2018
.gitattributes Initial Commit Jun 16, 2018
.gitignore URL Established Oct 29, 2018
README.md Update README.md Nov 9, 2018
deploy.bat Initial Commit Jun 16, 2018
mkdocs.yml Chat Rules Added Nov 18, 2018
process_anchors.py Initial Commit Jun 16, 2018

README.md

Tabletop Simulator Knowledge Base

This is the source of the knowledge base in Tabletop Simulator. It uses a modified version of Material-Design for MKDocs.

How it Works

The .md files in the /docs folder are written in Markdown, which is an easy-to-use markup language to add formatting to text. Additionally, some custom CSS is used, as well as a handful of custom images. When making changes, it is possible to live-preview them as you go if you have set up the local files for mkdocs + material design.

Alternatively, you can make modifications to individual pages then submit them for review. The developers will always be the ones to build and publish the site anyway, all you will do is modify the contents of this Git.

Installing

If you choose to install MKDocs so you can live-preview your changes, you may do so by following these instructions.

Otherwise, you will not need to install anything to edit the text files.