Skip to content

tatsy/node-diary

Repository files navigation

node-diary

Build Status Coverage Status Dependency Status devDependency Status

A Markdown-based note tool especially for users who want to archive images, videos, or source codes. The node-diary provides you not only Github flavored Markdown but also some original notations.

Overview

The node-diary supports following functions.

  • Github flavored Markdown rendering (based on markdown-it)
  • Number-based media specification (for images, videos, and source codes)
  • Video uploading (ffmpeg is required)
  • Special Markdown notation for <video> tag
  • Parallel video play in the same blockquote tag

Install

The installation requires two steps.

Step 1. In the application root, execute,

npm install

Step 2. In the node_modules directory,

git clone https://github.com/tatsy/marked.git
cd marked
git checkout imgsize

(I have sent pull request to the original marked authors, so please wait for more simple installtion.)

Step 3. Enable Evernote clipping

Please get developer token from https://www.evernote.com/api/DeveloperToken.action.

Rename config.template.json to config.json and paste your developer token in the file.

Usage

  1. Execute start-diary.cmd (Windows), or start-diary.sh (Linux and MacOS).
  2. Open http://localhost:3000 with your brouser.

Special Markdown

Number-based media specification

After you upload media files (image or viode files), you can specify them with a notation like %1.

![](%1)

is interpreted as

<img src="your_image_01.jpg" />

Support <video> tag

$[](your_movie.mp4)

is interpreted as

<video src="your_movie.mp4" controls></video>

In addition, you can upload source code file as well as media files. Specifying a source file with %1 will be replaced by the source code

Parallel video play

You can play multiple videos by placing them into a blackquote block and use a special markdown '''[Play]'''.

For example, following code will provide a play button for two videos put into a table.

>| A | B |
|:-:|:-:|
|$[](%1)|$[](%2)|
[Play]

Included external libraries

  • Bootstrap Copyright (c) 2011-2015, Twitter Inc. (MIT license)
  • jQuery Copyright (c) 2015, The jQuery Foundation (MIT license)

Copyright and licenses

Code copyright 2015, tatsy. Code released under the MIT license.

Acknowledgment

  • I thank Michael Dolejs for publicly providing Evernote icon in IconFinder.

About

A simple diary or notebook tool using Node.js and socke.io

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages