Skip to content

Home

Jump to bottom
adinilfeld edited this page May 13, 2021 · 10 revisions

Welcome to the chiventure wiki!

Sidebar

The wiki sidebar was generated using github-wiki-sidebar. The sidebar does not update automatically when new wiki pages are added, or titles are changed. After adding a new wiki page or editing a title, please update the sidebar using the following steps. (If this isn't your first time using github-wiki-sidebar with chiventure, skip to step 4.)

To update the sidebar:

  1. Make sure your title has the proper formatting, with bullet point levels separated by ~. For example, a wiki page with the title "Battles ~ User Stories ~ Enemies" will appear in the sidebar as
  • Battles
    • User Stories
      • Enemies

  1. Install github-wiki-sidebar using npm install github-wiki-sidebar -g. I wasn't able to install on the CSIL machines, but it should work well on personal computers. See the github-wiki-sidebar README for more detailed instructions.

  2. Clone the Chiventure wiki, using

git clone https://github.com/uchicago-cs/chiventure.wiki.git
cd chiventure.wiki
    1. Recommended: To update the sidebar with the default settings, simply run github-wiki-sidebar --silent --git-push.
    2. Not recommended: To update the sidebar with new settings, run github-wiki-sidebar --git-push. This will allow you to configure various options related to the sidebar. Important: do not change the category separator from ~ (unless you also change all the wiki titles).
Clone this wiki locally