Skip to content

Wiki pages render their markdown - #53

Merged
Rafael-SOWNet merged 1 commit into
masterfrom
wiki-pages-render-markdown
Oct 25, 2026
Merged

Rafael-SOWNet merged 1 commit into
masterfrom
wiki-pages-render-markdown

Conversation

@Rafael-SOWNet

Copy link
Copy Markdown
Member

The generator put each wiki page's markdown into the page unrendered, turning only backticks into code. So on the site:

  • links showed as [Here](https://…) on Expressions and Terminal;
  • bold showed as **…** and headings as ##, on Home and Parsing expression from string;
  • Home was one paragraph of raw markdown, with its seventeen links to the other pages;
  • code was not escaped, so the browser took a type argument for a tag. Compilation showed expr.Compile<float, float>("x") as expr.Compile ("x"), Multithreading showed AsyncLocal<T> as AsyncLocal, and Parsing showed Switch<object>( as Switch (;
  • the backtick rule broke F#'s ``d/dx`` names, in code blocks as well as in the text.

The pages are now rendered with Markdig, as GitHub renders the wiki, with the HTML in them passed through.

  • A link to another page of the wiki, written [Expressions](Expressions) the way GitHub expects, points at Expressions.html.
  • Inline code keeps the site's cw style.
  • Code blocks still carry no language class, because the site's highlight.js bundle has no F# and would skip a block marked as F#.

Markdig is BSD-2-Clause, and at 1.4.0 (2026-09-20) has no known vulnerabilities.

Checked on a local build, against a build of master:

  • Compared word by word, a page's visible text changes only where markdown showed or a code sample was cut. Basic operations, Differentiation, Exceptions, Integration, Jupyter notebooks, Limits, Settings, Solvers and the index are unchanged.
  • Pages are taller, because a blank line in the wiki now starts a paragraph, as it does on GitHub.
  • All 154 code blocks are still there.
  • All 17 links on Home lead to pages that exist.
  • No wiki page overflows at 320px or 390px.

One fix in the wiki itself: Simplification's heading "Conditions on the answer: `provided`" was an HTML <h2> with backticks inside it. Markdown is not read inside an HTML block, so GitHub showed the backticks, and so would this renderer. It is a markdown heading now (asc-community/AngouriMath.wiki@ada796f).

🤖 Generated with Claude Code

https://claude.ai/code/session_012sonx8iAspMiwRwokT1Ura

The generator put each wiki page's markdown into the page as it was,
turning only backticks into code. Everything else showed as written:
links as [Here](https://...), bold as **...**, headings as ##, and the
whole Home page as one paragraph of raw markdown. Code blocks were not
escaped either, so the browser took a type argument for a tag:
`expr.Compile<float, float>("x")` read `expr.Compile ("x")` on
Compilation, and `AsyncLocal<T>` read `AsyncLocal` on Multithreading. The
single-backtick rule also broke F#'s ``d/dx`` names, inside code blocks
too.

The pages are now rendered with Markdig, the way GitHub renders the
wiki, with HTML passed through. A link to another page of the wiki,
written `[Expressions](Expressions)` as GitHub expects, points at
Expressions.html. Inline code keeps the site's `cw` style, and code
blocks carry no language class, as before, because the site's
highlight.js has no F# and would leave such a block unhighlighted.

Against a build of master, the visible text changes only where markdown
was showing or a code sample was cut. Pages are taller, because a blank
line in the wiki now starts a paragraph. No wiki page overflows at 320px
or 390px.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012sonx8iAspMiwRwokT1Ura
@Rafael-SOWNet Rafael-SOWNet moved this to In review in AngouriMath Oct 25, 2026
@Rafael-SOWNet
Rafael-SOWNet merged commit 4f7ea76 into master Oct 25, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in AngouriMath Oct 25, 2026
@Rafael-SOWNet
Rafael-SOWNet deleted the wiki-pages-render-markdown branch October 26, 2026 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant