Skip to content

Commit 4be1262

Browse files
committed
docs: update all the READMEs with latest
1 parent 29c0d8d commit 4be1262

File tree

6 files changed

+70
-5
lines changed

6 files changed

+70
-5
lines changed

README.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ acdc/
7373

7474
== Known limitations
7575

76-
* **Table spanning**: Row/column spanning not implemented
7776
* **Inline markup in code/links**: Bold/italic inside code spans and link text not parsed
7877
* **Cross-file references**: LSP and parser are single-file only
7978

acdc-cli/README.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ cargo build --all-features
8282
* `manpage` - Manpage converter
8383
* `terminal` - Terminal converter with ANSI color support
8484

85+
=== Parser Options
86+
87+
* `setext` - Enable setext-style (two-line underlined) section headers
88+
89+
=== Syntax Highlighting
90+
91+
* `highlighting` - Enable syntax highlighting for source blocks in HTML output (uses syntect)
92+
8593
=== Development Tools
8694

8795
* `inspect` - AST inspection tool for debugging parser output
@@ -145,6 +153,13 @@ Convert with terminal backend:
145153
acdc convert --backend terminal document.adoc
146154
....
147155

156+
Terminal output with pager disabled:
157+
158+
[source,console]
159+
....
160+
acdc convert --backend terminal --no-pager document.adoc
161+
....
162+
148163
Convert to embeddable HTML (no DOCTYPE, html, head, body):
149164

150165
[source,console]

acdc-parser/README.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The implementation here follows from:
5656
** [x] Cell-level style (`s|`, `e|`, `m|`, `a|`, etc.)
5757
** [x] CSV, PSV, DSV formats
5858
** [x] AsciiDoc content in cells (`a` style)
59-
** [ ] Nested tables (not supported)
59+
** [x] Nested tables (`!===` delimiter in AsciiDoc cells)
6060
* [x] Admonition
6161
* [x] Anchors
6262
** [x] Block anchors (`\[[id]]`)
@@ -72,6 +72,7 @@ The implementation here follows from:
7272
* [x] Cross References
7373
** [x] xref macro
7474
** [x] Shorthand notation (\<<id>>)
75+
** [x] Attribute substitution in targets and text
7576
* [x] Links and URLs
7677
** [x] Link macro
7778
** [x] URL detection and autolinks

acdc-parser/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The implementation here follows from:
5656
* [x] Cell-level style (`s|`, `e|`, `m|`, `a|`, etc.)
5757
* [x] CSV, PSV, DSV formats
5858
* [x] AsciiDoc content in cells (`a` style)
59-
* [ ] Nested tables (not supported)
59+
* [x] Nested tables (`!===` delimiter in AsciiDoc cells)
6060
* [x] Admonition
6161
* [x] Anchors
6262
* [x] Block anchors (`[[id]]`)
@@ -72,6 +72,7 @@ The implementation here follows from:
7272
* [x] Cross References
7373
* [x] xref macro
7474
* [x] Shorthand notation (`<<id>>`)
75+
* [x] Attribute substitution in targets and text
7576
* [x] Links and URLs
7677
* [x] Link macro
7778
* [x] URL detection and autolinks

converters/html/README.adoc

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,53 @@ Supports all major AsciiDoc constructs:
4848
- **Text formatting**: Bold, italic, monospace, highlighting, subscript, superscript
4949
- **Lists**: Unordered, ordered, description lists, callout lists
5050
- **Blocks**: Listings, literals, examples, quotes, sidebars, open blocks
51-
- **Admonitions**: NOTE, TIP, IMPORTANT, WARNING, CAUTION
51+
- **Admonitions**: NOTE, TIP, IMPORTANT, WARNING, CAUTION (with Font Awesome icons when `:icons: font`)
5252
- **Media**: Images, videos (YouTube, Vimeo), audio
53-
- **Tables**: Full table support with headers, footers, and cell formatting
53+
- **Tables**: Full table support with headers, footers, cell formatting, cell spanning, and nested tables
5454
- **Cross-references**: Internal links and anchors
5555
- **Attributes**: Document-level attribute substitution
56+
- **Index terms**: Visible `((term))` and concealed `(((term,secondary,tertiary)))` with catalog generation
57+
58+
### Section Numbering
59+
60+
Documents with `:sectnums:` render numbered section headings (e.g., "1. Introduction", "1.1. Overview"). Control numbering depth with `:secnumlevels:` (default 3, max 5).
61+
62+
[source,console]
63+
....
64+
acdc convert -a sectnums -a secnumlevels=2 document.adoc
65+
....
66+
67+
Table of contents entries are also numbered when `:sectnums:` is set.
68+
69+
### Syntax Highlighting
70+
71+
Source blocks with a language specified render with syntax highlighting (requires the `highlighting` feature flag). Uses syntect with inline CSS styles.
72+
73+
[source,console]
74+
....
75+
cargo build --features highlighting
76+
acdc convert document.adoc
77+
....
78+
79+
Falls back to plain text when the language isn't recognized.
80+
81+
### Table Enhancements
82+
83+
Full table feature support:
84+
85+
- **Cell spanning**: colspan (`2+|`), rowspan (`.2+|`), combined (`2.3+|`)
86+
- **Visual attributes**: `frame`, `grid`, `stripes`, `width`, `%autowidth`
87+
- **Nested tables**: Using `!===` delimiter in AsciiDoc cells
88+
- **Cell-level formatting**: Alignment, styles (strong, emphasis, monospace, etc.)
89+
90+
### Substitution Control
91+
92+
Verbatim blocks (listing, literal) support the `subs` attribute:
93+
94+
- `subs=none` - disable all substitutions, output raw content
95+
- `subs=+quotes` - enable inline formatting in code blocks
96+
- `subs=+attributes` - enable attribute expansion
97+
- `subs=+replacements` - enable typography (arrows, dashes, ellipsis)
5698
5799
### Document Attributes
58100

converters/terminal/README.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ A simple terminal converter for `AsciiDoc` documents.
99
acdc convert --backend terminal simple.adoc
1010
....
1111

12+
When stdout is a TTY, output is automatically piped through a pager (defaults to `less -FRX` on Unix, `more` on Windows). Use `--no-pager` to disable, or set the `PAGER` environment variable for a custom pager.
13+
14+
[source,console]
15+
....
16+
acdc convert --backend terminal --no-pager simple.adoc
17+
....
18+
1219
image::images/simple.adoc.png["Simple Document"]
1320

1421
You can also pass multiple files and it will parse and print them all.

0 commit comments

Comments
 (0)