-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Convert tutorial.adoc to tutorial.md
- Loading branch information
Showing
2 changed files
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Converting ASCIIDOC to MD | ||
|
||
This tutorial was previously written using | ||
[AsciiDoctor](https://asciidoctor.org). In order to preserve comments, we | ||
manually converted from AsciiDoc to markdown. The following steps were applied | ||
by hand. | ||
|
||
1. Remove `[abstract]\n--` | ||
1. Remove metadata `:...:.*$` lines | ||
1. Convert headers `=` -> `#` | ||
1. Convert links `https://link.me[name]` -> `[name](https://link.me)` | ||
1. Convert inline code `` `+...+` `` -> `` `...` `` | ||
1. Convert code blocks `....` -> `` ``` `` | ||
1. Convert include directives `include_example(path/to/file)` | ||
``` | ||
` ` `c title="path/to/file" | ||
- - 8 < - - | ||
path/to/file | ||
- - 8 < - - | ||
` ` ` | ||
``` | ||
1. Convert comments `//...` -> `<!-- ... -->` | ||
1. Convert comment blocks | ||
``` | ||
//// | ||
comments... | ||
//// | ||
``` | ||
to | ||
``` | ||
<!-- | ||
comments... | ||
--> | ||
1. Convert images `image::path/to/image[title]` -> `???` | ||
1. Convert enumerated lists `. text` -> `1. text` | ||
1. Convert code blocks | ||
``` | ||
[source,c] | ||
---- | ||
code | ||
---- | ||
``` | ||
1. Convert indented list items | ||
``` | ||
* list item with the following indented code block | ||
+ | ||
[source,c] | ||
---- | ||
code | ||
---- | ||
``` |
File renamed without changes.