docs: self-rendered user manual (manual.md → manual.pdf)#44
Merged
Conversation
assets/readme/manual.md is a complete user manual — what the library is, install, quick start, the full feature tour (each feature used live in the document), theming, navigation/chrome, extension seams, CLI, examples index — and assets/readme/manual.pdf is that same file rendered BY the library: book-style contents with resolved page numbers, Page-N-of-M footer, auto-opened outline, vector emoji, smart punctuation. The closing section shows the exact composer used. ManualTest renders the committed source with that composer (kept in lockstep via ManualTest.manualComposer()) and asserts the demonstrated features land: outline PageMode, footer on every page, resolved TOC page numbers, em-dash/curly-quote replacements with verbatim code, emoji fallback, footnotes. README Documentation section links both.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The repo had a showcase page but no manual: one document that explains what the library is, how to install and use it, and demonstrates every feature — rendered by the library itself, so the PDF is its own proof.
What changed
assets/readme/manual.md— the full guide: what/why, install (incl. the optional fonts/emoji artifacts), quick start, ways-in/ways-out tables, a live feature tour (inline formatting + chips, smart punctuation, lists/tasks, tables, highlighted code, quotes/alerts/callouts, vector + geometric emoji, bidirectional footnotes), theming's three layers, navigation & chrome, extension seams, CLI, examples index — closing with the exact composer that built the PDF.assets/readme/manual.pdf— that file rendered by the library: book-style contents with live page numbers, "Page N of M" footer, auto-opened outline, vector emoji, smart punctuation (6 pages).ManualTest— renders the committed source with the documented composer (manualComposer(), kept in lockstep) and asserts the demonstrated features land:USE_OUTLINES, footer on every page, resolved TOC page numbers on page 1, em-dash/curly quotes with verbatim code, emoji fallback, footnotes.Verification
./mvnw clean verify→ BUILD SUCCESS, 180 tests, 0 failures. Page 1 visually confirmed: title block, dot-leader contents (pages 1–6, h2 entries indented), footer.