Zim

GitHub notebook

Registered by Jaap Karssenberg on 2014-01-08

Support github wiki as notebook backend
* Support (basic) GitHub flavored MarkDown as native format
   * Parser / Dumper
   * Configure features in pageview
* Flat store to support lack of namespaces in github wiki ??
* Notebook config templates to easy initialize such a notebook

Blueprint information

Status:
Not started
Approver:
None
Priority:
Undefined
Drafter:
None
Direction:
Needs approval
Assignee:
None
Definition:
Drafting
Series goal:
None
Implementation:
Unknown
Milestone target:
None

Related branches

Sprints

Whiteboard

The specification for the markdown syntax used by Github can be found at http://github.github.com/github-flavored-markdown/

This blueprint is mainly about Zim being able to handle Markdown-based notebooks. There is nothing particular about Github wikis, You can also use a plain git repo to store a markdown based notebook, Github will handle it fine, as well as some open source git repository viewers (for example GitList - http://gitlist.org/). An example of such a repository can be found at https://github.com/nodiscc/notes

Since markdown differs from zim wiki syntax in feature like e.g. handling line breaks there is some impact on the pageview widget to make it work seamless - but for first iteration we can leave that out - but will break WYSIWYG a bit.

(?)

Work Items

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.