https://github.com/samuell/mdnote

I couldn't find a suitable simple Markdown Notebook, so I "created an own"
https://github.com/samuell/mdnote

Last synced: 2 months ago
JSON representation

I couldn't find a suitable simple Markdown Notebook, so I "created an own"

• Host: GitHub
• URL: https://github.com/samuell/mdnote
• Owner: samuell
• License: mit
• Created: 2015-03-18T21:27:00.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-05-22T11:37:54.000Z (over 7 years ago)
• Last Synced: 2024-10-04T11:55:09.597Z (3 months ago)
• Language: Shell
• Size: 133 KB
• Stars: 65
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Markdown Notebook

I couldn't find a suitable simple Markdown Notebook, so I "created my own" 

![Screenshot](mdnotebook.png)

## Features

- Automatically creates a datestamped daily journal file, with the date in the heading

- Opens for editing in vim

- Commits and pushes the changes after closing vim

- A script to convert all files from markdown to html (if viewing on github/bitbucket is not enough)

## Dependencies

- Requires [pandoc](http://pandoc.org/) for the markdown-to-html conversion

## Usage

1. `git init .`

2. `git remote add origin `

3. `./editnewjournalfile.sh` (Will create a new datestamped file and open it in vim)

4. Write

5. Save

6. Exit (The journal will be committed and pushed to the origin at this point)

7. Create viewable file(s):

  - `./mdtohtml_perfile.sh` for one HTML file per journal file / day (in `html/` folder)

  - `./mdtoepub_perfile.sh` for one EPUB file per journal file / day (in `epub/` folder)

  - `./mdtohtml_merge.sh` for one single HTML page, with all journal files merged.

  - `./mdtoepub_merge.sh` for one single EPUB, with all journal files merged.

9. Open one of the generated files for viewieng history (could be `chromium-browser html/.html` (or `exo-open epub/.epub` to open in your OSs epub-reader, on ubuntu at least).)