tilvert
v1.0.2
Published
Simple Text to HTML CLI converter and SSG utility
Downloads
5
Readme
TILvert
A simple tool to convert TILs from txt files to HTML
Installation
$ pnpm install -g tilvert
# or using the release branch
$ pnpm install -g https://github.com/omalk98/TILvert.git#release
Uninstall
$ pnpm uninstall -g tilvert
Usage
$ tilvert [flags/options] <path>
If no path is specified, TILvert will read the current directory recursively to find all files with the matching extension (default "txt").
Flags
| Flag | Description | | ------------- | ----------------------------- | | -h, --help | Displays help information. | | -v, --version | Displays version information. |
Options
| Option | Description | | ---------------- | ------------------------------------------------------------------------------------------ | | -e, --extension | Extension for the files in the input directory. (Ignored if input is file). Default (txt). | | -o, --output | Path to the output directory. Default (./til). | | -s, --stylesheet | Path to the stylesheet. | | -l, --language | Language of the HTML page. | | --title | Title of the HTML page. | | --author | Author of the HTML page. | | --description | Description of the HTML page. | | --keywords | Keywords of the HTML page. | | --robots | Robots of the HTML page. | | --generator | Generator of the HTML page. | | --theme-color | Theme color of the HTML page. |
License
TILvert is licensed under the MIT License
Features
- [x] Convert txt files to HTML
- [x] Replicate directory structure in output directory
- [x] Non-destructive (Does not delete files in output directory)
- [x] Customizable language
- [x] Customizable HTML page title
- [x] Customizable HTML page with meta tags
- [x] Customizable stylesheet
- [x] Customizable extension for input files
- [x] Customizable output directory
- [x] Convert markdown files to HTML
Markdown Support
- [x] Links
- [x] Italics
- [x] Bold
- [x] Code Blocks
- [x] Horizontal Rules
Examples
Installed
$ tilvert -e txt -o ./til -s https://cdn.jsdelivr.net/npm/water.css@2/out/water.css --title "TIL" --author "omalk" --description "Today I Learned" --keywords "til, today i learned" --robots "index, follow" --generator "TILvert" --theme-color "#000000" ./example
From Source
$ node dist/main.js --extension txt --output ./til --stylesheet https://cdn.jsdelivr.net/npm/water.css@2/out/water.css
$ pnpm run start -- --extension txt --output ./til --stylesheet https://cdn.jsdelivr.net/npm/water.css@2/out/water.css