~skuzzymiglet/typeup-janet

3fc554c42d053c62cd2bb8a4d0ad8999820d74d6 — skuzzymiglet 2 months ago 5e8690f
Add readme and MIT license
2 files changed, 30 insertions(+), 0 deletions(-)

A LICENSE
A README.md
A LICENSE => LICENSE +9 -0
@@ 0,0 1,9 @@
The MIT License (MIT)

Copyright (c) 2021 skuzzymiglet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

A README.md => README.md +21 -0
@@ 0,0 1,21 @@
# typeup-janet

This is an implementation of the [typeup](https://skuz.xyz/typeup/) markup language in [Janet](https://janet-lang.org)

## Installation

[![Packaging status](https://repology.org/badge/vertical-allrepos/janet-lang.svg)](https://repology.org/project/janet-lang/versions)

1. Install Janet (see also [the official guide](https://janet-lang.org/introduction.html))
2. Install typeup: `sudo jpm install 'https://git.sr.ht/~skuzzymiglet/typeup-janet'`

## Usage

```sh
# typeup <output format>
typeup html # reads standard input, writes to standard output
typeup md # GitHub flavored markdown
typeup ast # Internal AST
typeup meta.title # Metadata key "title"
typeup html < document.tup > output.html
```