Bypass/change Markdown parser

Open
#264 5 comments 16 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
backend

Research direction

Start with src/renderer/html_handlebars/hbs_renderer.rs at the linked line, then read the existing Renderer and HtmlHandlebars flow to understand where parsing is selected. Define what an alternate parser or markup format must integrate with, and consider how the current renderer can support that without being duplicated; done means the parser choice is replaceable while existing rendering still works.

Written by the indexing model from the issue text.

Description

A-Rendering C-enhancement M-Discussion

It would be nice if there was a way to disable or swap out the Markdown parser for an some alternative Markdown parser (e.g. Pandoc) or a different markup format like reStructuredText or asciiDoc, etc.

I’m aware that you can do this by writing a new Renderer, but that means duplicating all the code that implements HtmlHandlebars, yet all I need is to tweak a single line of code.

Dominant language
Rust
Stars
22.2k
Forks
1.9k
Avg merge
2d 21h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-lang/mdBook

All issues in rust-lang/mdBook

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.