Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

jrnl-render

Current Version CI code style: prettier Dependabot Status

Render a jrnl file as a webpage.

jrnl is a command-line journaling application that stores in plain text files. If you put your files on Dropbox (or any other hosting service), you can use jrnl-render to generate a webpage for your journal(s).

Demo

https://jrnl-render-demo.netlify.com/

Quickstart

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
    <title>My JRNL</title>
  </head>
  <body>
    <!-- CHANGEME: Use your own URL here -->
    <jrnl src="https://dl.dropboxusercontent.com/s/abcdef1234/jrnl.txt" />
    <script src="https://unpkg.com/jrnl-render/dist/jrnl-render.standalone.min.js"></script>
  </body>
</html>

Customization

Customize title:

<jrnl jrnl-title="My Journal" src="..." />

Optional copyright in footer (supports Markdown):

<jrnl
  copyright="Copyright 2020 by [Steven Loria](https://stevenloria.com)"
  src="..."
/>

Custom loading message (supports Markdown):

<jrnl loading="⌛️ Loading..." src="..." />

Usage as a React component

npm i jrnl-render
import JRNL from "jrnl-render";

<JRNL
  src="..."
  title="My Journal"
  copyright="Copyright 2020 by Steven Loria"
/>;

Developing

  • npm install
  • To run tests: npm test
  • To run tests in watch mode: npm test -- --watch

Related

  • jrnl-parse - Parse a jrnl file in Node.js or the browser.

License

MIT Licensed.