suewonjp/Edit and review github wiki on your local machine.md

## Edit and review github wiki on your local machine.md

      
    Raw
  

              Edit and review github wiki on your local machine.md
            
          
    First, clone your github wiki to your local machine


Checkout your repository wiki via git.

 - You can find the URL at the lower-right of your wiki page (look for the label "Clone this wiki locally")
Now that you have pulled down a local copy of your github repo wiki, create a new file in the repo called _Sidebar.md
 - Note that other names might not work.
Within the newly created _Sidebar.md file, you can add appropriate [[link]] markdown syntax.
Add your new file to the local repository, and push via git push origin master.

With the same procedure, you can add a header(_Header.md) and footer(_Footer.md) file.
For more details, refer to https://help.github.com/articles/adding-and-editing-wiki-pages-locally/

Also, for a complete example, refer to https://github.com/suewonjp/civilizer/wiki
Install gollum


Prerequisites

Ruby, RubyGem


install gollum
gem install gollum

This may not go well at the 1st attempt;
On OS X, I needed to install icu4c package ( by running brew install icu4c )


review your wiki

Navigate to your git repository (wiki) via the command line.
Run: gollum
Open http://localhost:4567 in your browser.


For more details, refer to https://github.com/gollum/gollum
Extra

If you're a Vim user, then create a .vimrc in your local wiki directory, and add the following commands
set filetype=markdown

:nnoremap <f8> :wa \| !gollum > /dev/null 2>&1 &<CR>

:nnoremap <f9> :!kill $( pgrep -f gollum )<CR>

Now you can start the gollum server by pressing F8, and kill it by pressing F9 in your Vim.