https://github.com/uri/mdnotes

Take notes in markdown and then publish to html or pdf.
https://github.com/uri/mdnotes

Last synced: about 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/uri/mdnotes
• Owner: uri
• Created: 2012-05-30T15:30:01.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2012-05-30T15:35:37.000Z (about 14 years ago)
• Last Synced: 2025-05-07T06:08:34.182Z (about 1 year ago)
• Language: Ruby
• Size: 102 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
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](https://github.com/jdpace/PDFKit/wiki/Installing-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](http://urigorelik.info/).