https://github.com/sloria/jrnl-render

Render a jrnl (jrnl.sh) file as a webpage.
https://github.com/sloria/jrnl-render

javascript journal jrnl preact react rollup typescript

Last synced: 16 days ago
JSON representation

Render a jrnl (jrnl.sh) file as a webpage.

• Host: GitHub
• URL: https://github.com/sloria/jrnl-render
• Owner: sloria
• License: mit
• Created: 2018-07-26T00:24:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-03T20:57:04.000Z (over 4 years ago)
• Last Synced: 2024-12-04T01:02:10.604Z (22 days ago)
• Topics: javascript, journal, jrnl, preact, react, rollup, typescript
• Language: TypeScript
• Size: 3.65 MB
• Stars: 13
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jrnl-render

[![Current Version](https://img.shields.io/npm/v/jrnl-render.svg)](https://www.npmjs.org/package/jrnl-render)

![CI](https://github.com/sloria/jrnl-render/workflows/CI/badge.svg)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&identifier=142367266)](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

  

    

    My JRNL

  

  

    

    

    

  

```

## Customization

Customize title:

```html

```

Optional copyright in footer (supports Markdown):

```html

```

Custom loading message (supports Markdown):

```html

```

## Usage as a React component

```

npm i jrnl-render

```

```javascript

import JRNL from "jrnl-render";

;

```

## 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.