Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Markup for note taking

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 README.md
Octocat-spinner-32 notedown.gemspec
README.md

Notedown

Markup language designed for taking notes

Notedown is a markup language designed for outliner-style documents. It is optimized to be inputted fast (like when you're taking notes), yet still retain the ability to export the documents as nicely-formatted HTML.

Usage

Install:

$ gem install notedown

Pass filename(s) as arguments:

$ notedown file.nd > file.html

Or pipe via STDIN:

$ cat file.nd | notedown - > file.html

Example

This is a perfectly-valid Notedown document:

# Headings begin with a pound sign

  Paragraphs always end with a period.

  Anything else is a list item
  This is also a list item
    This is a sub-item, because of its indentation

  You may group items by putting empty lines on them

----

Horizontal rules are done with 4 or more dashes.

----

Lists with headings:
  If a list item ends with a colon (like above), it's a list item heading (bold)

This example translates to the following HTML:

<h1>Headings begin with a pound sign</h1>
<p>Paragraphs always end with a period.</p>

<ul>
  <li>Anything else is a list item</li>
  <li>This is also a list item
    <ul>
      <li>This is a sub-item, because of its indentation</li>
    </ul>
  </li>
</ul>

<ul>
  <li>You may group items by putting empty lines on them</li>
</ul>

<hr />
<p>Horizontal rules are done with 4 or more dashes.</p>
<hr />

<ul>
  <li><strong>Lists with headings</strong>
    <li>If a list item ends with a colon (like above), it's a list item heading (bold)</li>
  </li>
</ul>
Something went wrong with that request. Please try again.