Repository navigation
feat: v2.0.0 completed - #13
Merged
Merged
Conversation
A blockquote opening with [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], or [!CAUTION] now becomes a coloured callout with a label, the way GitHub renders it, instead of a plain quote with a literal "[!NOTE]" sitting in the text. The README's own banner is one of these, so it read badly in its own output. Plain quotes keep their existing look, now at the same width as a callout. The install instructions in that banner assumed nobody had the tool already, which is backwards: the people most likely to test are the ones who use it. Reported in #12, where a tester could not install the branch over an existing pipx install. They now build a throwaway virtualenv that leaves any existing install alone, with the pipx route as an alternative.
A tester installed the branch into a virtualenv, saw pip report 2.0.0, and then had the shell run an older copy from elsewhere on PATH — reporting bugs against 1.1.1 while believing they were on 2.0.0. `python -m doc_engine` always uses the environment you are standing in, so the instructions use that and explain how to check what the bare command resolves to.
Closes the last two roadmap items. Code blocks can be highlighted with a chosen theme rather than only Typst's default: --code-theme takes github, solarized, or monochrome, all bundled, or a path to any TextMate .tmTheme, so a theme from an editor works directly. The monochrome one exists because code printed in black and white loses meaning when colour is the only thing separating a keyword from a string. Inside a manifest build, a link from one included file to another now jumps within the PDF instead of pointing at a file the reader does not have. Each entry carries an anchor, and links that resolve to one are rewritten. Links to anything outside the build are untouched. The documentation catches up with what shipped: alerts, code themes, and cross-references get sections; the project configuration table lists all ten keys rather than three; and the settings module and themes folder join the project layout. The two remaining demos were still showing 1.x output, so they were re-recorded against v2, and the April header GIF that nothing referenced any more is gone.
A small badge in the header row, a button under the install line, and a section near the end explaining what sponsorship actually pays for. The FUNDING.yml already pointed at the same place, so the repository sidebar and the README now agree.
…s for release The first Mermaid diagram in a process takes about nine seconds: rendering one boots a JavaScript engine and loads Mermaid into it. Every diagram after that takes roughly a tenth of a second. That wait used to happen silently behind a spinner reading "Converting Markdown → Typst", which looks like a hang, and a nine second hang is where someone decides to try a different tool. The engine now starts under its own message saying what it is doing and that it happens once. Documents without diagrams are untouched. `info --json` prints the same facts as a machine-readable object — templates, themes, page sizes, accents — so an editor plugin or a script can populate its own menus instead of hardcoding lists that go stale. Documentation catches up with the release: the tester notice comes off the README now that this is the version going to PyPI, SECURITY moves its supported range to 2.0.x and names the new dependencies and the new surfaces worth reporting, and CONTRIBUTING lists all thirteen modules, the current template signature, and what CI actually runs.
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.
No description provided.