Index

Todos

Todos

  • General
    • h1 padding
    • Line-break padding
    • Admonition padding (see: this todo box)
    • Footer information
    • Wiki structure
    • Logo (upper left)
      • James' shoes from loading screen
    • Detail commit workflow
    • Fix navbar blur
  • Game related
    • Subtitle font (not Fedra?)
    • Test

Setup

  • Install Visual Studio Code: https://code.visualstudio.com/
  • Install Python 3: python.org/downloads
  • Install pip: https://bootstrap.pypa.io/get-pip.py
  • Install mkdocs with pip: pip install mkdocs && mkdocs --version
  • Install the Material theme with pip: pip install mkdocs-material
  • Install the PyMdown extension: pip install pymdown-extensions
  • Install Pygments: pip install pygments
  • Clone github repository: https://github.com/Roundlay/Silent.git
    • Ctrl+Shift+P
    • Git: Clone
    • Paste the repo. URL into the text field
    • Select a local path to store the repo. (Git will create a folder within this path, so if you create a new folder to store the Git repo. titled 'Silent Hill' inside a folder on your local system called 'Silent Hill', you'll end up with a local path along the lines of, \Silent Hill\Silent Hill\)

Usage

Only update documents in the docs folder; don't touch site, theme, etc.

  • git pull any new changes to your local machine
  • Add new pages or categories to the nav tree inside mkdocs.yml so that they'll appear in the navigation bar and tabs
  • Add some metadata to the top of your Markdown file (check sh1/index.md)

MkDocs

  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs help - Print this help message.
  • mkdocs gh-deploy - Update the live website.

Git

  • git pull (or Ctrl+Shift+P and Git: Pull in Visual Studio Code) to pull any updates from repository.
  • git commit (or Git: Commit) to stage and commit changes.
  • git push (or Git: Push) to push changes to master branch.

Project layout

1
2
3
4
mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Extension Demo

Lorem Ipsum™

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

Task List

  • Item 1
    • Item A
    • Item B
      • More Text
      • Item a
      • Item b
      • Item c
    • Item C
  • Item 2
  • Item
\frac{n!}{k!(n-k)!} = \binom{n}{k}

Nulla Sed Quam Dignissim

You can remove the title from these hint boxes by defining the hint-box type (in this case Note) and appending it with double quotation marks.

Latin

Nulla sed quam dignissim, mattis mauris sit amet, elementum ligula. Sed vel lacus euismod, euismod urna gravida, vestibulum ipsum. Donec porta urna eget sagittis rutrum. Aenean et molestie mi. Fusce pretium neque nisl, vel sollicitudin turpis volutpat eget. Vestibulum vitae tortor neque. Nam sed quam orci. Praesent suscipit lorem ultricies rhoncus aliquam. Vivamus tristique sagittis metus, nec ornare elit ultricies pellentesque.

Sometimes you'll need to reference key strings using the Keys extension:

Ctrl+Alt+Our Special Place

Highlighting things

First Header Second Header Third Header Fourth Header
Content Cell Content Cell Content Cell Content Cell
Content Cell Content Cell Content Cell Content Cell

Using the Critic extension, you can highlight incorrect text, correct text, and important text. You can even highlight entire paragraphs:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

With the Mark extension, you can highlight text. :)

Pellentesque gravida

Pellentesque gravida porta quam nec pulvinar. Pellentesque tempor tempor leo, sit amet imperdiet arcu euismod ut.1 Quisque ex tellus, interdum malesuada elit vitae, sagittis ultricies felis. Praesent pharetra tincidunt tortor, nec commodo mauris lobortis non. Fusce porttitor fermentum porta. Interdum et malesuada fames ac ante ipsum primis in faucibus. Maecenas ultricies, ante et lobortis congue, purus elit ullamcorper risus, vitae egestas nunc sapien ac lacus.

1
2
3
4
5
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

A Winner is You

You can change the default hint-box title by adding it next to the hint-box type ID (in this case Success) inside quotation marks.

Open styled details

You can put anything in here.

Nested details!

And more content again.


  1. Lorem ipsum dolor sit amet, consectetur adipiscing elit.