Skip to content

Commit

Permalink
Mention Marked specifically and why it was dropped
Browse files Browse the repository at this point in the history
  • Loading branch information
spenserblack committed Nov 12, 2024
1 parent 20f03b8 commit c2b1a84
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions packages/site/src/App.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,21 @@
<main>
<h1>Steamdown</h1>
<p>
Welcome to the beta test of the new version of Steamdown! Previously, it just used
an existing Markdown renderer, and used a bunch of settings overrides to hack it
into something that could render to Steam's markup. Now, it has its own parser and
renderer written specifically with Steam's markup in mind. There's some new syntax,
some changed syntax, and some removed syntax, with the goal of handling the
possibilities and limitations of Steam's markup. View the
Welcome to the beta test of the new version of Steamdown! Previously, it used and
applied overrides and extensions to
<a href="https://marked.js.org/">Marked</a>, a JavaScript library that parses and
renders Markdown. While <a href="https://marked.js.org/">Marked</a> is a great library, there were a few problems when
overriding its behavior to target Steam's markup:
</p>
<ul>
<li>Some of Markdown's syntax didn't have proper equivalents in Steam's markup.</li>
<li>Since <a href="https://marked.js.org/">Marked</a> was built to render to HTML, some hacky methods needed to be taken (like un-escaping escaped HTML).</li>
<li>There was a decent amount of unused code, since almost every renderer in <a href="https://marked.js.org/">Marked</a> was overridden.</li>
</ul>
<p>
Now, it has its own parser and renderer written specifically with Steam's markup in
mind. There's some new syntax, some changed syntax, and some removed syntax, with
the goal of handling the possibilities and limitations of Steam's markup. View the
<a href="https://github.com/spenserblack/steamdown">GitHub Repository</a>
for more information on the changes.
</p>
Expand Down

0 comments on commit c2b1a84

Please sign in to comment.