aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2025-04-18 16:27:11 +0700
committerShulhan <ms@kilabit.info>2025-04-18 16:27:11 +0700
commit552a3d83e549ead4c348f94d2a704ec9e23d0a6c (patch)
tree591225f6c8cb45b5473df37ed01c0bed9c2af157
parent02bd8e9662cef9cf2c5f1ae0b560e7070c9fc564 (diff)
downloadasciidoctor-go-552a3d83e549ead4c348f94d2a704ec9e23d0a6c.tar.xz
README: update notes related to Includes directive
Changes, * Link the Includes feature to the official documentation * Update Unsupported Markup related to Includes * Update list of TODO related to Includes * Move CHANGELOG to Development section
-rw-r--r--README.md28
1 files changed, 12 insertions, 16 deletions
diff --git a/README.md b/README.md
index 561a897..d79a5f6 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,5 @@
# asciidoctor-go
-Author: [Shulhan](mailto:ms@kilabit.info)
-
The asciidoctor-go is the Go module to parse the
[AsciiDoc markup](https://asciidoctor.org/docs/what-is-asciidoc)
and convert it into HTML5.
@@ -99,10 +97,7 @@ The numbered one is based on the old documentation.
* Internal Cross References
* Customizing the Cross Reference Text
* [Footnotes](https://docs.asciidoctor.org/asciidoc/latest/macros/footnote/)
-* Include Directive
- * Anatomy
- * Processing
- * File resolution
+* [Includes](https://docs.asciidoctor.org/asciidoc/latest/directives/include/)
* Images
* Video
* YouTube and Vimeo videos
@@ -178,13 +173,12 @@ or inconsistent with others markup, or not secure,
Never should it be.
* Using different cell separator
-* Include Directive
- * Select Portions of a Document to Include.
+* Includes
+ * [Include Content by Tagged Regions](https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/)
Rationale: the parser would need to know the language to be included and
parse the whole source code to check for comments and tags.
- * Include Content from a URI.
+ * [Include Content by URI](https://docs.asciidoctor.org/asciidoc/latest/directives/include-uri/)
Rationale: security and unreliable network connections.
- * Caching URI Content
#### Unordered list item with hyphen
@@ -232,10 +226,11 @@ List of features which may be implemented,
* Cross References
* Inter-document Cross References
* Include Directive
- * AsciiDoc vs non-AsciiDoc files
- * Normalize Block Indentation
- * Include a File Multiple Times in the Same Document
- * Using an Include in a List Item
+ * Offset Section Levels
+ * Indent Included Content
+ * Use an Include File Multiple Times
+ * Include List Item Content
+ * Include Content by Line Ranges
* Text Substitutions
* Macros
* Incremental Substitutions
@@ -262,8 +257,6 @@ parent -> Parent Node.
### Miscellaneous
-[Changelog](CHANGELOG.html).
-
The following files compare the HTML generated by asciidoctor and this
library:
@@ -273,6 +266,9 @@ library:
## Development
+[Changelog](CHANGELOG.html)::
+List of each releases and their changes.
+
[Repository](https://git.sr.ht/~shulhan/asciidoctor-go)::
Link to the source code.