goldfish

command module
v0.2.2 Latest Latest
Warning

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

Go to latest
Published: Jun 4, 2015 License: MIT Imports: 10 Imported by: 0

README

Goldfish

Download

A personal wiki / notes blend powered by markdown and git.

Inspired by Evernote and gollum.

Features

  • Just files on your disk. Actually, a git repo on your disk.
  • A server and a web-frontend, all in a single executable. The server manages files, your browser displays them.
  • Files are markdown with some extensions:
    • LaTeX $\latex$ or, if you want it on its own line, \[ \latex \])
    • Easier links [[foo]], also works for images [[foo.png]]

Future features:

  • Search
  • Auto-push
  • Auto-Update of files and folders
  • Windows support

Usage

If you're on linux, make sure to install either libinotifytools or inotifytools.

# Or whatever path suits you
./goldfish ~/goldfish

Then open http://localhost:2345 and start writing those markdown files :)

Screenshot time!

Code for the page:

# Demo Page

## Markdown

Things you could do:

- Make _important_ notes
- Write in __strong__ letters

## Equations

Both $e^\text{inline}$ and in display mode:

\[
  e^{i \pi} = -1
\]

## Syntax Highlighting

```ruby
foo = Bar.new
puts foo if foo.baz?
```

## Images

[[fish.png]]

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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