Skip to content

Commit 494d3d3

Browse files
committed
Convert tutorial.adoc to tutorial.md
1 parent e886adc commit 494d3d3

File tree

3 files changed

+2288
-1850
lines changed

3 files changed

+2288
-1850
lines changed

src/asciidoc_to_md.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Converting ASCIIDOC to MD
2+
3+
This tutorial was previously written using
4+
[AsciiDoctor](https://asciidoctor.org). In order to preserve comments, we
5+
manually converted from AsciiDoc to markdown. The following steps were applied
6+
by hand.
7+
8+
1. Remove `[abstract]\n--`
9+
1. Remove metadata `:...:.*$` lines
10+
1. Convert headers `=` -> `#`
11+
1. Convert links `https://link.me[name]` -> `[name](https://link.me)`
12+
1. Convert inline code `` `+...+` `` -> `` `...` ``
13+
1. Convert code blocks `....` -> `` ``` ``
14+
1. Convert include directives `include_example(path/to/file)`
15+
```
16+
17+
` ` `c title="path/to/file"
18+
- - 8 < - -
19+
path/to/file
20+
- - 8 < - -
21+
` ` `
22+
23+
```
24+
1. Convert comments `//...` -> `<!-- ... -->`
25+
1. Convert comment blocks
26+
```
27+
////
28+
comments...
29+
////
30+
```
31+
to
32+
```
33+
<!--
34+
comments...
35+
-->
36+
1. Convert images `image::path/to/image[title]` -> `???`
37+
1. Convert enumerated lists `. text` -> `1. text`
38+
1. Convert code blocks
39+
```
40+
[source,c]
41+
----
42+
code
43+
----
44+
```
45+
1. Convert indented list items
46+
```
47+
* list item with the following indented code block
48+
+
49+
[source,c]
50+
----
51+
code
52+
----
53+
```

0 commit comments

Comments
 (0)