Skip to content

Latest commit

 

History

History
136 lines (76 loc) · 4.07 KB

HowTo.md

File metadata and controls

136 lines (76 loc) · 4.07 KB

Prerequisites

  1. A basic understanding of the markdown language.

  2. You will need to create a free github account if you don't have one. Recommend you use the name of your RPG as this will become part of the URL people will use to access your SRD.

  3. You can do this whole process through the browser without knowing git. Though learning github desktop will allow you to test any changes locally before deploying them live for the world to see.

The Process

Creating the Repository on Github

  1. Login to Github

  2. Navigate to the public template /~https://github.com/nerun/RPG_SRD_Template

  3. Click "Use this template"

Step3

  1. Select "Create a new repository"

  2. Enter a repository name

Step5

  1. Select 'Private'

  2. Select 'Create repository'

It will take 5-30 seconds to copy the template, then you'll have your own copy.

  1. Ensure that you have the file ".nojekyll" this is an empty file that is needed when hosting a website on Github otherwise the SRD will not display properly. (Tells GitHub Pages not to run the published files through Jekyll).

Adding Your Content

*.md Files

.md files are markdown files, Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Depending on the size of your content you can either place all your game's information in a single *.md file, or create separate files for each chapter. The "sample.md" provides some formatting examples.

Markdown language is very easy to learn, use the link provided on point 2 under Prerequisites above for a full list of syntax.

_sidebar.md

This is your menu, navigation pane on the left side of the website. Once you have added a markdown file to your repository you need to add the file here so that its contents are included. Follow the existing formatting.

_navbar.md

This is your top navigation bar, it works the same as _sidebar.md but allows for dropdown menus.

Enable Github Pages to turn the Repository into a Website

  1. In your repository click on 'Settings':

Website-Step1

  1. Select 'Pages' on the left hand side menu:

Website-Step2

  1. If you haven't made the repository 'public', you have two choices: a. Make the repository public which will then allow you to use Github pages to host your SRD Website for free. b. Upgrade your Github account (at the time of writing this it costs \$4 a month or \$48 annual fee).

  2. Under 'Branch' select 'main' and click save.

  3. Give it 10-20 seconds then refresh the page.

  4. You'll now see your URL such as https://coweater.github.io/mysrd:

Website-Step6

Changing Fonts

  1. Edit the /_assets/style.css file.

  2. Under the "body section" you'll find siteFont & headingFont.

  3. Change these to the fonts you want to use.

Using Fontawesome and/or Material Icons plugin to display free icons in your SRD

Fontawesome

Use Fontawesome to get free icons and animated icons. Subcribed users can use Pro Icons:

  1. Find the icon on Fontawesome.
  2. Select the icon.
  3. In the popup window, under the HTML tab, copy everything between "quotes":
<i class="fa-solid fa-dice-d20"></i>
  1. Place the copied text between ":", no spaces:
:fa-solid fa-dice-d20:

Material Icons

Use Material Icons for more free icons:

  1. Find the icons on Material Icons.
  2. Copy & insert the web span link directly into your markdown files
<span class="material-icons">face</span>

LaTeX with MathJax

If needed to use some formulas, you can use Scruel's docsify-latex plugin with MathJax syntax.

For inline math use:

This $ e = mc^2 $ is Einstein's formula.

For display (block) math:

This is Einstein's formula:

$$
E=mc^2
$$

It's possible to replace $ and $$ symbols by custom ones, read plugin documentaion.