https://github.com/lithammer/go-wiki

A simple HTTP server rendering Markdown styled documents
https://github.com/lithammer/go-wiki

go wiki

Last synced: 20 days ago
JSON representation

A simple HTTP server rendering Markdown styled documents

• Host: GitHub
• URL: https://github.com/lithammer/go-wiki
• Owner: lithammer
• License: mit
• Archived: true
• Created: 2014-12-04T19:28:14.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-06-16T06:58:06.000Z (about 9 years ago)
• Last Synced: 2024-05-02T05:36:03.430Z (about 2 months ago)
• Topics: go, wiki
• Language: Go
• Homepage: http://lithammer.github.io/go-wiki
• Size: 5.05 MB
• Stars: 300
• Watchers: 15
• Forks: 29
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• my-awesome-stars - lithammer/go-wiki - A simple HTTP server rendering Markdown styled documents (Go)

README

        
# Go Wiki

A simple HTTP server rendering Markdown styled documents on the fly and optionally shows its git history including diffs.

**NOTE** This is toy project to help me learn Go, so don't run this on anything publically available.

![Screenshot1](https://cloud.githubusercontent.com/assets/177685/5720761/2337178e-9b29-11e4-8a86-224f7905b3f6.png)

## Installation

```bash

$ go get github.com/renstrom/go-wiki

$ $GOPATH/bin/go-wiki 

```

## Customize

It's only possible to customize the CSS. Put all your customizations in a file of your choosing and point to it using the `--custom-css` flag.

```bash

$ go-wiki ~/www/wiki --custom-css=

```

## Usage

Create git repository containing your Markdown formatted wiki pages.

### On the server

Create an empty repository.

``` bash

$ mkdir -p ~/www/wiki && cd $_

$ git init

$ git config core.worktree ~/www/wiki

$ git config receive.denycurrentbranch ignore

```

Setup a post-receive hook.

``` bash

$ cat > .git/hooks/post-receive <` and `` with credentials for your specific machine.

``` bash

$ git init

$ git remote add origin \

    ssh://@/home//www/wiki

```

Now create some Markdown file and push.

``` bash

$ git add index.md

$ git commit -m 'Add index page'

$ git push origin master

```

## License

MIT