This repo is super Outdated. After forking the project mmagnus allowed me to collaborate directly to the original project.
Please take a look at https://github.com/mmagnus/geekbook for the current version.
-----------------------------
This is a fork of the original project by mmagnus. I'm just making it more suitable for my tastes :P
The following text refers to the original project + some personal editing.
(under heavy development)
A neat way how to combine Emacs (not requried) + Markdown Syntax + Git + Html engine (bootstrap/python) to get the best notes-talking experience ever. Highly customizable with plugins written in Python. What's the most important, under the hood it's just a set of Markdown files.. you can do with them whatever you want, e.g. you can Pandoc (http://pandoc.org/epub.html) them to epub (that's origin of "book" part of the name).
Freatures:
- Index html based
- Sync them with Dropbox/iCloud/github
- Read from console, grep them
- Edit with almost any text editor, I'm using Emacs!
- Keep images separately, edit them in any external tool or edit them in batch
- Customize html templates
- You can sync notes in your system with notes kept at virtual machines (mounted via sshfs) or drives
- Super light!
- Pandoc markdown files to anything you want!
- Use 3rd party editors, if you wish, on your computer or on your phone.
I recommend to use Emacs (or VIM or other super-powerfull editor) to:
- run git on your notes in your editor,
- grep them in the editor,
- make bookmarks to parts of your notes,
- copy-paste from your notes to your programs you're writing,
- use Google Translate (https://github.com/atykhonov/google-translate)
- ispell,
- outline mode,
- focuse mode.
Sync with Github to have your notes (full-text searchable) with you all the time (in a private repository):
Kinda similar projects:
[tableofcontent] # give you table of content in a given place of your note
[date] # give you date when a note was compiled
https://www.emacswiki.org/emacs/Magit
Spotlight your notes:
On your phone: (in this case using Dropbox & Byword on my iPhone).
Or Draft (http://lifehacker.com/draft-is-a-clean-note-taking-app-with-markdown-support-844836670) for Android (not tested by me).
Requirements: pip install markdown (https://pypi.python.org/pypi/Markdown)
Requirements: pip install py-gfm (http://pythonhosted.org/py-gfm/)
To get the code:
Original project - git clone git@github.com:mmagnus/geekbook.git
This project - git clone git@github.com:akaped/geekbook.git
To run:
$ python app/geekbookapp.py
root path: /Users/magnus/Dropbox
html path: <file:///Users/magnus/Dropbox/geekbook/data/html/index.html>
/home/magnus/Dropbox/geekbook/data/md/
2017-01-04 21:09:25: (network.c.410) can't bind to port: 1234 Address already in use
Could not execute http daemon lighttpd -f.
geekbook is up... [ok]
compiling... test.md [ok]
open your browser and copy-paste the html path (in my case is file:///Users/magnus/Dropbox/geekbook/data/html/index.html).
To make a new note, create a file in <path to your geekbook>/data/md/<notes here>. Keep geekbookapp.py running all the time, it will detect a new note and compile it for you.
You can combine short notes into long ones.