North Pittsburgh Meatpackers

    diaryjs

    0.0.3 • Public • Published

    DiaryJS

    Read your Markdown diary as a single-page HTML document.

    Installation

    Installing via npm

    Installation is done via the Node Package Manager. You can install DiaryJS globally:

        $ npm install -g diaryjs

    and also locally, if you don't want to use it from your terminal:

        $ npm install diaryjs --save

    Usage

    In order to keep things simple we restrict ourselves to this directory structure:

    .
    └── days/
        ├── 2015/
        ├── 2016/
            └── 08/
                ├── 09.markdown
                ├── 10.markdown
                └── 11.markdown
            └── 09/
        └── 2017/

    Your notes have to follow this naming rule or the diary will not render properly.

    To read your diary just simply run

        $ diaryjs 

    from the directory where your days folder is located in. If no errors occur, your diary will appear in the same folder as diary.html. You're done! :)

    Install

    npm i diaryjs

    DownloadsWeekly Downloads

    0

    Version

    0.0.3

    License

    MIT

    Last publish

    Collaborators

    • avatar