| Age | Commit message (Collapse) | Author |
|---|
|
**🌼 all: add aria-label to the anchor when sectanchor enabled**
The aria-label help user with screen reader to discern and navigate
the anchor.
For more information see
https://dequeuniversity.com/rules/axe/4.11/link-name .
**🌼 all: update default CSS to asciidoctor v2.0.26**
The default CSS now split into separate file to simplify tracking and
modifying the style as needed.
|
|
|
|
This is to make it easy to see how it parsed and how it written to HTML,
make the code more searchable.
While at it, add test for block image.
|
|
The idea is to provide consistent naming for metadata and attribute.
The AsciiDoctor documentation mostly name them as document attribute.
|
|
Previously, an empty line before Document Title cause the parser
stop parsing the document header, now an empty lines are skipped.
Also document attribute can be place anywhere, either before or
after title, and in between attributes; now it can be only placed
after revision or author or title.
|
|
The HTML file can be viewed by running "make serve-doc" and opening
http://127.0.0.1:8080/test.html .
It provide a textarea where developer can input partial HTML and a
button Preview to render the partial HTML on the right.
|
|
I use two remote repositories: GitHub and SourceHut.
GitHub support rendering README using asciidoc while SourceHut not.
This cause the repository that use README.adoc rendered as text in
SourceHut which make the repository page less readable.
Also, the pkg.go.dev now render README but only support Markdown.
Since we cannot control the SourceHut and go.dev, the only option is
to support converting Markdown in ciigo so I can write README using
Markdown and the rest of documentation using Asciidoc.
How did Markdown become defactor standard? Its lack comment, creating
table of content, macro, and many more.
|
|
The idea is to allow viewer to view the repository CHANGELOG without
changing to directory _doc.
|
|
=== New features
* all: add support for document attribute "last-update-label"
* all: implement inline macro for passthrough ("pass:")
* all: implement macro "footnote:"
=== Bug fixes
* all: detach parsing preamble from content.
This is to prevent empty preamble being rendered in HTML content.
* all: fix the orders of generated HTML meta
=== Enhancements
* all: support multi line attribute values
|
|
|
|
If the attribute value end with backslash '\', the value continue to the
next line.
|
|
The inline passthrough "pass:" can be used to control the substitutions
applied to a run of text.
Ref: https://docs.asciidoctor.org/asciidoc/latest/pass/pass-macro/
|
|
The meta key name must start with letter, digits, or _, but after
that _ is not allowed.
|
|
Macro footnote grammar,
----
"footnote:" [ REF_ID ] "[" STRING "]"
----
In asciidoctor, footnote can be placed anywhere, even after WORD without
space in between.
The REF_ID, define the unique ID for footnote and can be used to reference
the previous footnote.
The first footnote with REF_ID, should have the STRING defined.
The next footnote with the same REF_ID, should not have the STRING
defined; if its defined, the STRING is ignored.
|
|
=== Bug fix
* all: fix parsing list description inside include directive
=== Chores
* all: update share module to v0.41.0
* all: move all documentation into directory _doc
|
|
While at it reformat the README, add section for development, add
link for Go documentation.
|
