jrnl-render
v5.0.0
Published
Render a jrnl (jrnl.sh) file as a webpage.
Downloads
73
Readme
jrnl-render
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-renderimport 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.