jrnl-render
Version:
Render a jrnl (jrnl.sh) file as a webpage.
89 lines (64 loc) • 1.94 kB
Markdown
# jrnl-render
[](https://www.npmjs.org/package/jrnl-render)
[](https://github.com/prettier/prettier)
[](https://dependabot.com)
Render a [jrnl](http://jrnl.sh) 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
```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:
```html
<jrnl jrnl-title="My Journal" src="..." />
```
Optional copyright in footer (supports Markdown):
```html
<jrnl
copyright="Copyright 2020 by [Steven Loria](https://stevenloria.com)"
src="..."
/>
```
Custom loading message (supports Markdown):
```html
<jrnl loading="⌛️ Loading..." src="..." />
```
## Usage as a React component
```
npm i jrnl-render
```
```javascript
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](https://github.com/sloria/jrnl-parse) - Parse a jrnl file
in Node.js or the browser.
## License
MIT Licensed.