A note taking application, featuring markdown syntax.
Python CSS Makefile Batchfile QMake Shell HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api_docs
ci
locale Improvements for French translation Sep 12, 2015
mikidown
.editorconfig
.gitignore
.local.vimrc
.local.vimrc.example
.travis.yml Nope, Travis CI still can't get PyQt5 Apr 28, 2016
CONTRIBUTING.md Add utility debugging function May 11, 2016
Changelog.md
LICENSE Upload to pypi, close #18. Aug 17, 2013
MANIFEST Bump version because of creation of MANIFEST.in Oct 8, 2015
MANIFEST.in
README.mkd Add note about python3 asciimathml May 6, 2016
fabfile.py Add api docs Feb 23, 2016
mikidown.desktop Explicitly add all files/directories to QFileSystemWatcher, fix `miki… Nov 26, 2013
mikidown.pro
mikidown.py Replace Process with Thread because windows can't Jul 21, 2014
setup.py
test.py

README.mkd

Mikidown

Master build status: master Build Status Develop build status: develop Build Status

Mikidown is a note taking application with markdown.

Mikidown was inspired by Zim and based on ReText. The logo is derived from markdown-mark.

Install mikidown with

python3-pip install mikidown

Run mikidown without installing

git clone https://github.com/shadowkyogre/mikidown.git
cd mikidown
./mikidown.py

Features

  • Edit markdown with live preview
  • Switch between Edit/View/LiveEdit mode
  • All notes in one place, with multiple notebooks support
  • Page cross-link
  • Import from plain text files, export to HTML, PDF
  • Customise your note style (by editing CSS file)
  • Spell check

Dependencies

  • Python.3+
  • PyQt.5+
  • python-markdown
  • python-whoosh
  • python-html2text ( Optional for HTML to markdown conversion, otherwise, formatted text is pasted as HTML )
  • python-asciimathml ( Optional for asciimathml support )
  • python-pyenchant ( Optional for spell checking )
  • slickpicker ( Optional for better color picking for mikidown highlighting colors )

Beautiful notes powered by markdown

In case you are unfamiliar with markdown, you can use this file (Help->README) as a simple reference to basic markdown syntax. However, Its suggested to look at the complete Markdown Syntax.

Markdown extension

All python-markdown extensions are supported. To enable/disable extension, edit the notebook.conf file in your notebook folder.

# notebook_folder/notebook.conf
extensions=nl2br, strkundr, codehilite, fenced_code, headerid, headerlink, footnotes

Mikidown Specific Syntax

  1. page cross link

    • [text](/parentNode/childNode/pageName)
    • [text](/parentNode/childNode/pageName#anchor)
  2. absolute and relative image path

    • ![text](file:///home/user/pic.png)
    • ![text](pic.png) # path relative to notebook folder
    • Ctrl + I or Edit -> Insert Image will bring up an insert image dialog.
  3. ins/del/bold/italics

    • ~~delete~~ will yield delete
    • __insert__ will yield insert
    • **strong** will yield strong
    • //emphasis// will yield emphasis

Contributors

ShadowKyogre and more

Fork and help are much appreciated.

Want to help? Further details are in the CONTRIBUTING.md file.