syaronote

module
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2016 License: MIT

README

SyaroNote

SyaroNote is Markdown wiki for personal and small group.

Features

Build

Go and nodejs are required.

syaro
go get github.com/OUCC/SyaroNote
go build -ldflags "-X main.version=$(git describe)" -o build/syaro github.com/OUCC/SyaroNote/syaro
editor
cd editorjs
npm install
npm run deploy
copy public
npm install
bower install
gulp copy
git plugin (optional)
cd $GOPATH/src/github.com/libgit2/git2go
git submodule update --init
make install
go install

cd $GOPATH/src/github.com/OUCC/SyaroNote
go build -o build/gitplugin github.com/OUCC/SyaroNote/gitplugin

Usage

./syaro path/to/wiki

# if public and template folders placed outer than working dir
SYARODIR=/path/to/syaro/dir syaro path/to/wiki

Then open localhost:8080/Home in your browser.

syaro -h or syaro --help you can see more options.

Contribution

Fork and pull requests welcome.

Donate

About

Author
  • @yuntan
  • @susisu (Table editor)
  • @spring-raining (emoji)
License

This software is released under MIT License.

Softwares

Following softwares are used:

Directories

Path Synopsis
gitservice
Package gitservice is a generated protocol buffer package.
Package gitservice is a generated protocol buffer package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL