Journal: A Personal Publishing Platform

Journal. \ˈjər-nəl\ Noun. Definition: chronicle, account, narrative, life.

Journal is a markdown-focused blogging platform. It keeps all the markdown for all you posts and generates static files to serve them as html.

It's small, simple, and fast!

Isn't it mysterious to begin a new journal like this? I can run my fingers through the fresh clean pages but I cannot guess what the writing on them will be. ― Maud Hart Lovelace

Instalation

Assuming you have NodeJS installed already then you can just run journal directly through npx.

  npx journal

You can also install the binary globally like so:

  npm i -g journal

Usage

journal [command] [args]

Commands

• journal build - builds a journal
• journal serve - starts a httpserver locally to serve any content [aliases: view]

Config Arguments (which can be overriden):

• `-c, --config [default: /journal.json]

Directory Arguments: (overrides config)

• -i, --input, --content Location of markdown to be parsed [default: /content/]
• -o, --output Location to output generated html [default: /build/]
• -s, --static Location of static files (css, images, etc) [default: /static/]

Other Arguments

• -v, --version Show version number [boolean]
• -h, --help Show help [boolean]

Examples:

$ journal                               Basic usage, uses defaults
$ journal --config myconfig.json        Use a custom config file
$ journal -i '../custom/dir'            Use a custom content directory
$ journal view                          Start a server for built content
$ journal view --config myconfig.json   Start server with a custom config

License

Journal is licensed under the Apache License 2.0, which is available in the LICENCE.md file.

Meta