gollum-wiki-template
This is a lightweight gollum wiki template based on the origin-template. This wiki will be hosted automatically in your local machine when you start the ubuntu after the installation. You can edit the content in markdown and preview the page from the browser directly whenever you want.
You can build your own wiki from now on.
build your own wiki repo
Just fork this repo to your account and clone it to your computer.
git clone git@github.com:Magic-wei/gollum-wiki-template.git && cd gollum-wiki-template
Install
If it is your first time to install dependencies, please run commands below.
bash install.bash # install dependencies
bash setup.bash # set up the autostart service
If you have already installed the dependencies and just want to switch between different computers, just run the command below to set up the service:
bash setup.bash
Then you can get your localhost IP from the feedback:
Created service.bash file
Created the wiki.conf file.
Prepare auto start service for the wiki.
Init folder is already there!
Start the service!
Already have the autostart folder.
wiki start/running, process 5801
localhost:8888 # here is your localhost IP 8888.
Usage
Open your browser and check the wiki out by localhost:8888.
Start and Stop wiki
This wiki will be hosted automatically when you start the ubuntu. You don't need to run commands below.
start wiki # start to host the wiki, the "wiki" is defined by the COMMAND variable.
stop wiki # stop to host the wiki, the "wiki" is defined by the COMMAND variable.
Adjustable Parameters
You can modify the port number of your wiki in script file setup.bash,
PORT=4567 # hosting port
Then run the command:
bash setup.bash
Below is your service name of your wiki.
COMMAND=wiki # default value is wiki
The Gollum Configuration used by this repo:
Gollum::Page.send :remove_const, :FORMAT_NAMES if defined? Gollum::Page::FORMAT_NAMES
wiki_options = {
:live_preview => true,
:allow_uploads => true,
:per_page_uploads => true,
:allow_editing => true,
:css => true,
:js => true,
:mathjax => true,
:h1_title => true,
:emoji => true
}
Precious::App.set(:wiki_options, wiki_options)