diff options
| author | Cody Logan <cody@lokken.dev> | 2023-11-27 16:18:39 -0800 |
|---|---|---|
| committer | Cody Logan <cody@lokken.dev> | 2023-11-27 16:18:39 -0800 |
| commit | f21363103bf296d87ea78a6e0fbfb2caed4c195c (patch) | |
| tree | d49d0bb84a1446dbafcd2c20b7299b19f4d0f0e9 /README.md | |
| parent | 2de662aec9fb17cd0fc3d91206d7137b5782303a (diff) | |
| download | convert-markdown-f21363103bf296d87ea78a6e0fbfb2caed4c195c.tar.gz convert-markdown-f21363103bf296d87ea78a6e0fbfb2caed4c195c.zip | |
Update README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 20 insertions, 18 deletions
@@ -1,9 +1,11 @@ # convert-markdown -Simple Markdown to HTML converter using lowdown_file(3). +Simple Markdown to HTML converter using [lowdown(3)][lowdown]. ## Usage +Pass Markdown to stdin and get an HTML fragment on stdout: + ```console $ convert-markdown # header @@ -12,26 +14,26 @@ hello **world** <h1 id="header">header</h1> <p>hello <strong>world</strong></p> +$ convert-markdown < file.md > output.html ``` -```console -$ convert-markdown < README.md -<h1 id="convert-markdown">convert-markdown</h1> - -<p>Simple Markdown to HTML converter using lowdown_file(3).</p> - -<h2 id="Usage">Usage</h2> +## License -<pre><code class="language-console">$ convert-markdown -# header -hello **world** -[Ctrl-D] -<h1 id="header">header</h1> +This code is adapted from the example section of [lowdown_file(3)][lowdown_file], which is part of +[lowdown][lowdown-site] by Kristaps Dzonsons <kristaps@bsd.lv>. Lowdown is free software released under the terms of the +[ISC license][isc]. -<p>hello <strong>world</strong></p> -</code></pre> -``` +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, +provided that the above copyright notice and this permission notice appear in all copies. -## License +THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF +THIS +SOFTWARE. -[ISC](https://opensource.org/license/isc-license-txt/) +[lowdown]: https://kristaps.bsd.lv/lowdown/lowdown.3.html +[lowdown_file]: https://kristaps.bsd.lv/lowdown/lowdown_file.3.html +[lowdown-site]: https://kristaps.bsd.lv/lowdown/ +[isc]: https://opensource.org/license/isc-license-txt/ |