Skip to content

Commit

Permalink
Stop mentioning PEG.js
Browse files Browse the repository at this point in the history
Given up that attempt.
  • Loading branch information
spenserblack authored Oct 30, 2024
1 parent 272ca50 commit ea941e1
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions packages/steamdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ Converts Markdown to [Steam's markup][format].

**:warning: I am rewriting this project to use an internal parser instead of using extensions and custom renderers with [Marked](https://github.com/markedjs/marked). In doing so, the supported syntax will likely change slightly, because some of Markdown's syntax doesn't have an equivalent in Steam's markup. Some of Markdown's syntax will be either disabled or repurposed. For example, while URLs in Steam's markup have `[url=//example.com]text[/url]`, images don't have an equivalent, so the `![image name](//example.com/image.png)` syntax might be disabled. Tables in Steam do *not* support alignment, but *do* support the `noborder` and `equalcells` attributes, so the table syntax may *look* similar to Markdown, but serve a different purpose.**

:bow: Also, I've been slow with updates because I haven't been 100% happy with the implementations I've written. Even though they work fine, they don't feel maintainable. Instead of "hand-writing" a parser, I'm currently playing around with PEG.js/Peggy, and hopefully this will result in a maintainable parser.

## Usage

### Website
Expand Down

0 comments on commit ea941e1

Please sign in to comment.