https://github.com/gera2ld/marktiddly
Render Markdown files as tiddlers
https://github.com/gera2ld/marktiddly
markdown tiddlywiki
Last synced: over 1 year ago
JSON representation
Render Markdown files as tiddlers
- Host: GitHub
- URL: https://github.com/gera2ld/marktiddly
- Owner: gera2ld
- License: mit
- Created: 2022-08-31T13:25:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T05:28:07.000Z (over 1 year ago)
- Last Synced: 2025-04-15T06:43:23.163Z (over 1 year ago)
- Topics: markdown, tiddlywiki
- Language: TypeScript
- Homepage: https://gera2ld.github.io/marktiddly/
- Size: 547 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MarkTiddly
Render Markdown files as a single static page.
You can take notes in Markdown files and publish them as a single HTML file so you can access them from anywhere.
## Features
- Single HTML page
- Easy to deploy
- Portable
- Password protection (OpenPGP)
- Data compression (Pako)
## Demos
- https://gera2ld.github.io/marktiddly/ - without encryption
- https://gera2ld.github.io/marktiddly/encrypted - with data protected by a password
## Usage
Basic usage:
```base
$ npx marktiddly generate --cwd my-docs -o output.html
$ open output.html
```
Protect data with a password:
```bash
$ npx marktiddly generate \
--cwd my-docs \
-o output.html \
--pgp 'My Password' \
--pgp-hint 'Ask Mom for the password' \
--glob 'public/*.md'
$ open output.html
```
You can also try the demo in this repository with the command below:
```bash
$ npx marktiddly serve --cwd demo --default-open marktiddly
# Then visit http://localhost:4000
```