Skip to content

uri/mdnotes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MDNotes

Basics

"Using a terminal, cd into the directory you want to takes notes.

Use command mdnotes to create a notes directory.

Create your markdown (.md) in the md/ directory.

Use mdnotes to 'compile' your notes into html. These will be located in the html/ folder.

Use mdnotes -p or mdnotes --publish to create pdf's of your notes. These will be located in the pdf/ folder.

If you want to include images in your notes you can place them in the images folder located under ./html/images. Use ![alt-text](./images/my_image.png) to reference an image.


Install

To install gem install mdnotes. To uninstall gem uninstall mdnotes.


Requirements

Requires rdiscount and pdfkit for pdf utility.

Creating PDFs

Install WKHTMLTOPDF for the pdf publishing to work. You can use the following commands:

curl -O http://wkhtmltopdf.googlecode.com/files/wkhtmltopdf-0.9.9-OS-X.i368
mv wkhtmltopdf-0.9.9-OS-X.i368 /usr/local/bin/wkhtmltopdf
chmod +x /usr/local/bin/wkhtmltopdf

Or using homebrew

brew install wkhtmltopdf

You can find out more about me.

About

Take notes in markdown and then publish to html or pdf.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages