tub78 / gollum-bootstrap

Bootstrap your repository's wiki with Gollum

Accessing Your GitHub Repository Wiki

Requirements

1. Repository hosted on GitHub
2. Wiki initialized on GitHub

1. Clone Your Project Repository

On your local system:

  git clone https://github.com/USER/PROJECT.git PROJECT-REPO

2. Clone Gollum Bootstrap

From your project repo:

  git clone https://github.com/tub78/gollum-bootstrap.git gb
  echo "gb" >> .gitignore

3. Clone Your Wiki

From your project repo:

Run the following commands to clone the GitHub wiki. These commands are included in clone-wiki.sh, which you can run instead. [1]

  REMOTE=$(git config --get remote.origin.url)
  WIKIREMOTE=$(dirname $REMOTE)/$(basename $REMOTE .git).wiki.git
  git clone $WIKIREMOTE wiki
  echo "wiki/" >> .gitignore

After cloning, look for the default Home.md file under wiki/.

4. Edit & Publish Your Wiki

From your wiki repository:

Try this:

  echo "" >> Home.md
  echo "Hello world" >> Home.md

then run commit.sh:

  git commit -a -m "Test"

and publish the page with publish.sh:

  git push -u origin master

Local Previews

Requirements

1. Ruby installation including gem executable

1. Install Gollum

The recommended way to install the Ruby framework Gollum is with Bundler. Bundler is a Ruby package manager that installs Gollum via a set of Gems listed in Gemfile. Knowledge of Ruby and installation of gems is required. I recommend configuring your Ruby installation with rbenv.

From the gb directory:

Run install-bundler.sh to install Bundler. This just executes the following command:

  gem install bundler

Next, run install-gollum.sh to install Gollum, executing the following commands:

  bundle install --path ../vendor/bundle
  bundle install --binstubs ../bin
  echo "vendor/" >> ../.gitignore
  echo "bin/" >> ../.gitignore

2. View

To view a local instance of your wiki, run gollum. Once the Gollum server is initialized, navigate to http://localhost:4567. Gollum only serves pages that have been committed to the repository.

From your project repo:

  bin/gollum wiki/

Notes

[1]: You will get an error if you have not clicked on the "Wiki" tab under your GitHub repository.

fatal: https://github.com/USER/PROJECT.wiki.git/info/refs not found: did you run git update-server-info on the server?