https://github.com/mikeshultz/wikionastick

A wiki that runs on, and renders markdown documents from a thumbdrive
https://github.com/mikeshultz/wikionastick

Last synced: about 1 year ago
JSON representation

A wiki that runs on, and renders markdown documents from a thumbdrive

• Host: GitHub
• URL: https://github.com/mikeshultz/wikionastick
• Owner: mikeshultz
• License: mit
• Created: 2017-11-17T08:53:38.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-19T08:26:14.000Z (over 8 years ago)
• Last Synced: 2025-01-03T21:16:45.775Z (over 1 year ago)
• Language: Go
• Homepage:
• Size: 38.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Wiki On A Stick

[![Build Status](https://travis-ci.org/mikeshultz/wikionastick.svg?branch=master)](https://travis-ci.org/mikeshultz/wikionastick)

A wiki that runs on, and renders markdown documents from a thumbdrive.

![Screenshot](https://i.imgur.com/hJwDVw4.png)

## Install

### Automagic Install

    WOS_INSTALL_PATH=/mnt/thumb-drive bash <(curl -s https://raw.githubusercontent.com/mikeshultz/wikionastick/master/install_usb.sh)

You can review [the installer script](https://github.com/mikeshultz/wikionastick/blob/master/install_usb.sh)

ahead of time, but this is the easiest way to install WikiOnAStick to a **mounted**

thumbdrive.

If you only need a specific OS supported, set `WOS_OS` to one of the following:

`linux64`, `darwin64`, `freebsd64` or `win64`.

### Manual

1) Grab a copy of the release from the [releases](https://github.com/mikeshultz/wikionastick/releases)

page.

2) Create a directory on your thumbdrive that will contain your docs

3) Unzip/untar files to that directory

4) Create documentation files, with `index.md` or `README.md` as the default 

page.  All links are relative.

See the Example below for more information.

## Usage

	Usage:

	  wikionastick [OPTIONS]

	Application Options:

	  -t, --template= Path to a template directory

	  -l, --loglevel= Log level. ['debug', 'info', 'warning', 'error']

	Help Options:

	  -h, --help      Show this help message

## Templates

You can create your own HTML/CSS/JS templates. Just copy the directory 

`templates/default` to `templates/mytemplate` and modify files as necessary.  

You will have to invoke `wikionastick` with the new template path:

    wikionastick -t templates/mytemplate

## Example

Thumbdrive layout:

    /mnt/thumbdrive

        wikionastick

        templates/

            default/

                base_template.html

                main.css

        README.md

        docs/

            example.md

README.md:

    # Hello!

    World.  See my [example notes](docs/example.md).