# Atext2html [Atext2html](https://crates.io/crates/atext2html) is a command line utility written with [Nom](https://crates.io/crates/nom) to recognize hyperlinks and link reference definitions in Markdown, reStructuredText, Asciidoc, Wikitext and HTML formatted text input. [Atext2html](https://crates.io/crates/atext2html) renders the source text verbatim to HTML while making hyperlinks clickable. By default the hyperlink's text appears the same as in the source text. When the flag `--render-links` is given, hyperlinks are represented only by their link text, which makes inline links more readable. [![Cargo](https://img.shields.io/crates/v/atext2html.svg)]( https://crates.io/crates/atext2html) [![Documentation](https://docs.rs/atext2html/badge.svg)]( https://docs.rs/atext2html) [![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)]( https://gitlab.com/getreu/atext2html) [Atext2html](https://crates.io/crates/atext2html) illustrates the usage of the underlying library [Parse-hyperlinks](https://crates.io/crates/parse-hyperlinks). The [API of Parse-hyperlinks](https://docs.rs/parse-hyperlinks/0.19.6/parse_hyperlinks/index.html) provides insights about the operating principle of this utility. In addition to the above, [Parse-hyperlinks-extras](https://crates.io/crates/parse-hyperlinks-extras) defines some extra parsers needed by the [Tp-Note](https://crates.io/crates/tp-note) application. ### Installation: ```bash cargo install atext2html ``` # Usage ``` Render source text with markup hyperlinks. USAGE: atext2html [FLAGS] [OPTIONS] [FILE]... FLAGS: -h, --help Prints help information -l, --only-links print only links (one per line) -r, --render-links render hyperlinks -V, --version print version and exit OPTIONS: -o, --output print not to stdout but in file ARGS: ... paths to files to render (or `-` for stdin) ``` # Usage examples ## Markdown 1. Create a file `input.txt` with text and hyperlinks: ```md abc[text10](destination10 "title10")abc abc[text11][label11]abc abc[text12](destination2 "title12") [text13]: destination3 "title13" [label11]: destination1 "title11" abc[text13]abc ``` 2. Run `atext2html`: ```shell $ ./atext2html -o output.html input.txt ``` 3. Inspect `output.html`: ```html

abc[text10](destination10 "title10")abc
   abc[text11][label11]abc
   abc[text12](destination2 "title12")
   [text13]: destination3 "title13"
   [label11]: destination1 "title11"
   abc[text13]abc

``` This is how it looks like in the web browser: ```shell $ firefox output.html ```

   abc[text10](destination10 "title10")abc
   abc[text11][label11]abc
   abc[text12](destination2 "title12")
   [text13]: destination3 "title13"
   [label11]: destination1 "title11"
   abc[text13]abc

## reStructuredText 1. Create a file `input.txt` with text and hyperlinks: ```rst abc `text21 `_abc abc text22_ abc abc text23__ abc abc text_label24_ abc abc text25__ abc .. _label21: destination21 .. _text22: destination22 .. __: destination23 __ destination25 ``` 2. Run `atext2html`: ```shell $ ./atext2html -o output.html input.txt ``` 3. Inspect `output.html`: ```html

abc `text21 <label21_>`_abc
   abc text22_ abc
   abc text23__ abc
   abc text_label24_ abc
   abc text25__ abc
      .. _label21: destination21
      .. _text22: destination22
      .. __: destination23
      __ destination25

``` This is how it looks like in the web browser: ```shell $ firefox output.html ```

   abc `text21 <label21_>`_abc
   abc text22_ abc
   abc text23__ abc
   abc text_label24_ abc
   abc text25__ abc
      .. _label21: destination21
      .. _text22: destination22
      .. __: destination23
      __ destination25

## Asciidoc 1. Create a file `input.txt` with text and hyperlinks: ```adoc abc abc https://destination30[text30]abc abc link:https://destination31[text31]abc abc{label32}[text32]abc abc{label33}abc :label32: https://destination32 :label33: https://destination33 ``` 2. Run `atext2html`: ```shell $ ./atext2html -o output.html input.txt ``` 3. Inspect `output.html`: ```html

abc
   abc https://destination30[text30]abc
   abc link:https://destination31[text31]abc
   abc{label32}[text32]abc
   abc{label33}abc
   :label32: https://destination32
   :label33: https://destination33

``` This is how it looks like in the web-browser: ```shell $ firefox output.html ```

   abc
   abc https://destination30[text30]abc
   abc link:https://destination31[text31]abc
   abc{label32}[text32]abc
   abc{label33}abc
   :label32: https://destination32
   :label33: https://destination33

## Wikitext 1. Create a file `input.txt` with text and hyperlinks: ```wikitext abc abc[https://destination31 text31]abc ``` 2. Run `atext2html`: ```shell $ ./atext2html -o output.html input.txt ``` 3. Inspect `output.html`: ```html

abc
   abc[https://destination31 text31]abc
   ```

   This is how it looks like in the web-browser:

   ```shell
   $ firefox output.html
   ```

      abc
   abc[https://destination31 text31]abc
   


## HTML

1. Create a file `input.txt` with text and hyperlinks:

   ```html
   abctext1abc
   abctext2abc
   ```

2. Run `atext2html`:

   ```shell
   $ ./atext2html -o output.html input.txt
   ```

3. Inspect `output.html`:

   ```html
   abc<a href="dest1" title="title1">text1</a>abc
   abc<a href="dest2" title="title2">text2</a>abc
   ```

   This is how it looks like in the web-browser:

   ```shell
   $ firefox output.html
   ```

      abc<a href="dest1" title="title1">text1</a>abc
   abc<a href="dest2" title="title2">text2</a>abc