Skip to content

GitHub Wiki HowTo

Brian "Beej Jorgensen" Hall edited this page Dec 13, 2017 · 4 revisions

Code

Syntax highlighting:

#include <stdio.h>

int main(void)
{
   printf("Hello, world!\n");
   return 0;
}

Pages written in markdown.

Can clone the wiki and edit markdown in the editor of your choice.

Searching

By Page Title

Type in the "Pages" bar on the right to search by page title.

By Page Content

Enter the search text in the top-of-page search bar. On the results page, click the "Wikis" subtab.

This link gets you to the Wikis subtab directly, after which you have to type a search term up top: https://github.com/LambdaSchool/CS-Wiki/search?utf8=%E2%9C%93&q=&type=Wikis

Cloning the Wiki Repo

  1. Go back to the main repo page (the <> Code tab).
  2. Copy the clone ssh URL
  3. Add the word .wiki just before the .git, like so: [email protected]:LambdaSchool/CS-Wiki.wiki.git

Subdirectories in the Repo

Although the wiki displays as flat, you can have subdirectories. However, you must make them from the command line in a clone of the wiki.

Even though it's possible to add custom sidebars and footers in subdirectories, it's not recommended. The web UI is hardcoded to overwrite the root header/sidebar file, even if you edit one in a subdirectory.

Inserting Images

Adding Images to Wikis (GitHub help)

Are you sure about that?

![Are you sure about that?](https://github.com/LambdaSchool/CS-Wiki/blob/master/wiki-images/cypher-disbelief.jpg)

There's a general-purpose wiki-images subdirectory in the repo that can be used as an image dump.

Home page

The page titled "Home" has special meaning as your root page. Things work better if you don't rename "Home".

References

GitHub wiki help

Adding Images to Wikis

Beginner's Guide to GitHub Wiki

GitHub wiki reference

Viewing wiki change history

Cloning wiki repo via ssh