Skip to content

ShadowKyogre/mikidown-personal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mikidown

Mikidown is a markdown note taking application.

You can also use it as a markdown text editor.

Mikidown is inspired by Zim and based on ReText.


Features

  • Take and organize notes
  • Markdown syntax
  • Live preview
  • Import and save as plain text files
  • Export to HTML, PDF
  • Support multiple notebooks
  • Customise your note style (by editting CSS file)

Dependencies

  • Python (>3.0)
  • PyQt
  • python-markdown

How-To

Get the source code

git clone git@github.com:rnons/mikidown.git
cd mikidown

You should be able to run mikidown with ./mikidown.py.

However, to visualize your notes with the help of CSS file, you can choose to install mikidown.

python setup.py install

Open any terminal and issue command mikidown to bring Mikidown up.


Use Mikidown to visualize you notes

You can find this file in the menu: Help->README.

If you are unfamiliar with markdown, you can use this file as a simple reference to basic markdown syntax.

However, I suggest you take a look at the complete Markdown Syntax.

Changes made by me:

  • Properly support relative URLS
  • use wiki:// to indicate a link within the notebook
  • Fix PDF support

Helps needed

This is my first real world Python+PyQt program.

Currently, the code is a bit ugly. Please fork and help.

About

This is a mirror of my personal copy of mikidown

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published