add example run on README

main
Melody Horn 2020-10-05 13:28:27 -06:00
parent 5206ffd851
commit b251441782
2 changed files with 46 additions and 1 deletions

37
README.gmi 100644
View File

@ -0,0 +1,37 @@
# md2gemtext
[image: builds.sr.ht status]
=> https://builds.sr.ht/~boringcactus/md2gemtext.svg [image: builds.sr.ht status]
=> https://builds.sr.ht/~boringcactus/md2gemtext? builds.sr.ht status
for converting Markdown into gemtext.
=> https://gemini.circumlunar.space/docs/specification.html gemtext
## standalone usage
```
cargo install md2gemtext
md2gemtext /path/to/some/file.md /path/to/some/file.gmi
```
## library usage
```
let gemtext = md2gemtext::convert("some markdown")?;
```
## translation rules
* "thematic breaks" (hr tags) are translated to `-----` on a line by itself
* headings turn into headings, levels beyond 3 get capped at 3
* code blocks get turned into code blocks (info strings are discarded)
* something happens to HTML, i forget what
* paragraphs get empty lines between them, because i think that looks better
* block quotes get turned into quotes (multi-paragraph contiguous block quotes break though)
* lists get turned into lists ("loose lists" probably misbehave, nested lists _definitely_ misbehave, numbering is not preserved)
* ``markdown code spans`` retain their backticks
* `_italics_` are surrounded by single underscores
* `**bold**` is surrounded by double asterisks
* `a [link](a://url) with context` turns into `a link with context` followed by `=> a://url link`
* `an ![inline](a://url) image` turns into `an [image: inline] image` followed by `=> a://url [image: inline]`
* if a link or image is its own paragraph, it becomes just the gemtext link, to not be redundant

View File

@ -211,7 +211,7 @@ impl State {
#[cfg(test)]
#[test]
fn run_tests() {
fn test_kitchen_sink() {
let markdown_demo = r#"
# h1
## h2
@ -276,3 +276,11 @@ fn test_list_start() {
let gemtext = "> hi\n\n* uh\n* ah\n";
assert_eq!(convert(markdown), gemtext);
}
#[cfg(test)]
#[test]
fn test_readme() {
let markdown = include_str!("../README.md");
let gemtext = include_str!("../README.gmi");
assert_eq!(convert(markdown), gemtext);
}