1
0
Fork
You've already forked spock
0
A simple desktop Wiki engine built around Markdown and git
  • Go 76%
  • HTML 15.8%
  • Roff 4.2%
  • CSS 1.3%
  • Makefile 1.1%
  • Other 1.6%
Find a file
2018年01月28日 14:36:16 +00:00
cmd/spock small API change in bleve 2014年12月12日 12:42:03 +01:00
data fix cancel buttons 2014年09月23日 15:21:35 +02:00
debian update debian control file 2015年07月13日 17:26:35 +02:00
vendor add govendor support 2018年01月28日 14:36:16 +00:00
.gitignore add govendor support 2018年01月28日 14:36:16 +00:00
auth_views.go simplify url patterns 2014年09月22日 13:36:00 +02:00
AUTHORS add LICENSE and AUTHORS files 2014年09月06日 15:06:28 +02:00
BUGS.txt delete old bugs 2014年09月05日 01:31:41 +02:00
cfg_spock.json add a sample configuration file 2014年09月06日 13:33:01 +02:00
config.go add LICENSE and AUTHORS files 2014年09月06日 15:06:28 +02:00
doc.go add LICENSE and AUTHORS files 2014年09月06日 15:06:28 +02:00
gitstorage.go add govendor support 2018年01月28日 14:36:16 +00:00
gitstorage_test.go fix Fatal call in tests 2014年09月07日 11:37:42 +02:00
helpers.go add LICENSE and AUTHORS files 2014年09月06日 15:06:28 +02:00
helpers_test.go add some more tests 2014年09月07日 12:08:51 +02:00
htmlfuncs.go add govendor support 2018年01月28日 14:36:16 +00:00
index.go another small API change in bleve 2015年07月05日 13:58:43 +02:00
LICENSE add LICENSE and AUTHORS files 2014年09月06日 15:06:28 +02:00
Makefile add govendor support 2018年01月28日 14:36:16 +00:00
page.go use pandoc to render non markdown documents 2015年07月13日 17:18:53 +02:00
page_test.go add some more tests 2014年09月07日 12:08:51 +02:00
page_views.go add govendor support 2018年01月28日 14:36:16 +00:00
README.md add govendor support 2018年01月28日 14:36:16 +00:00
runlinux.sh arch independent linux launcher 2014年09月08日 22:02:49 +02:00
spock.1 update documentation 2015年07月13日 17:25:00 +02:00
storage.go use pandoc to render non markdown documents 2015年07月13日 17:18:53 +02:00
utils.go add LICENSE and AUTHORS files 2014年09月06日 15:06:28 +02:00
utils_test.go add some more tests 2014年09月07日 12:08:51 +02:00
web.go simplify url patterns 2014年09月22日 13:36:00 +02:00

Spock wiki

Spock is a simple wiki software heavily inspired by GitHub's Gollum and is mostly intended as a personal documentation system. I wrote it as a frontend for my technical notes.

Please note: This is alpha software and a toy project: use with caution!

Why another wiki software?

  • I don't want to fight with runtime dependencies, virtualenvs and such.
  • I have a bunch of notes written in Markdown and RestructuredText formats.
  • I like to edit wiki pages with my text editor.
  • I like to use git to maintain the history of my notes.
  • I don't want to run a full LAMP stack just to use my wiki.
  • I'm having some fun learning Go.

Features

  • wiki pages can be written in Markdown or RestructuredText and can be edited with your preferred text editor
  • git is used as the underlying storage system
  • full text search (experimental)
  • nice browser editor thanks to CodeMirror

NOTE: RestructuredText is not rendered by Go code, see below.

Usage

The first time you launch Spock it will need to create the repository directory:

./spock -repo ~/Documents/wiki -init

Typical usage:

./spock -repo ~/Documents/wiki

Installing Spock from sources

Runtime requirements:

  • pandoc optional, enable rendering of rst and org documents

Build requirements:

  • recent version of Go (tested with Go 1.3+)
  • a C compiler
  • git (to fetch some go dependencies)
  • govendor
  • mercurial (to fetch some go dependencies)
  • libgit 0.23.x
  • icu4c
  • leveldb (optional)

On a Debian based GNU/Linux system you should be able to install almost all the required dependencies running:

sudo apt-get install pandoc cmake git mercurial libicu-dev libleveldb-dev

You must build libgit2 0.22.x by yourself.

On OS X with homebrew:

brew install mercurial icu4c leveldb libgit2

Building Spock

You can build Spock by running make; if you system doesn't ship with an updated version of libleveldb you can edit the Makefile and remove leveldb from the Go build tags.

Author

Daniel Kertesz daniel@spatof.org

Spock includes a copy of CodeMirror 4.5: https://github.com/marijnh/codemirror