question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Configure docsify to use markdown-it

See original GitHub issue

Feature request

Enable the use of markdown-it renderer instead of marked.

What problem does this feature solve?

Docsify is an incredibly well designed documentation generator and its ease of use with Github pages makes it well suited to that purpose. Docsify uses the marked renderer.

Unfortunately, the markdown tool ecosystem is very fragmented and it is difficult to choose feature rich markdown editing tools that will render with high fidelity across static website generation frameworks. On the editing side, HackMD (& CodiMD) is a pack leader for collaboration on Github based markdown. The HackMD VSCode extension also provides a great developer experience. It uses the modern and extensible markdown-it renderer. Its plugin model is allowing it to evolve fast and create the kind of modern content that is expected in blogs, docs, and websites.

What does the proposed API look like?

Not an API change, but presumably it involves swapping out the underlying node packages

These are the markdown-it dependencies in HackMD:

  "dependencies": {
    "markdown-it": "^10.0.0",
    "markdown-it-abbr": "^1.0.4",
    "markdown-it-container": "^2.0.0",
    "markdown-it-deflist": "^2.0.3",
    "markdown-it-footnote": "^3.0.2",
    "markdown-it-imsize": "^2.0.1",
    "markdown-it-ins": "^2.0.0",
    "markdown-it-mark": "^2.0.0",
    "markdown-it-mathjax": "^2.0.0",
    "markdown-it-regexp": "^0.4.0",
    "markdown-it-sub": "^1.0.0",
    "markdown-it-sup": "^1.0.0",
    "markdown-it-task-checkbox": "^1.0.6",
    "markdown-it-emoji": "^1.4.0"
  }

How should this be implemented in your opinion?

I believe that markdown-it’s extensibility makes it a great default choice for docsify and having more future-proof. Alternatively, I would be happy to have instructions for swapping out the renderer.

Are you willing to work on this yourself?

Yes. Assuming I am not missing some reason why this isn’t pluggable. I would need assistance from docsify core contributors.

Issue Analytics

  • State:open
  • Created 3 years ago
  • Reactions:7
  • Comments:31 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
yzhang-ghcommented, Jun 3, 2020

My +1 for the markdown-it parser. I really like the extensibility of markdown-it as a VSCode Markdown plugin maintainer.

MD plugins

1reaction
jack9603301commented, Apr 29, 2020

Thanks, because I chose WP RMD when I developed it, I know it is an excellent markdown renderer!

Read more comments on GitHub >

github_iconTop Results From Across the Web

markdown-it 13.0.1 API documentation
MarkdownIt provides named presets as a convenience to quickly enable/disable active syntax rules and options for common use cases.
Read more >
docsify
A magical documentation site generator. Simple and lightweight; No statically built html files; Multiple themes. GitHub Getting Started.
Read more >
Markdown-it-table-of-contents - npm.io
markdown-it -table-of-contents. A table of contents plugin for Markdown-it. Simple, customizable and with a default slugifier that matches that of ...
Read more >
Using Docsify with ASP.NET (NOT Core) - DanylkoWeb
While Docsify provides quick documentation using markdown, it was a ... I also had to set up the application so it could serve...
Read more >
Automatic Documentation For JavaScript Projects
When using JSDoc to document JavaScript code with doc-strings, the next step is to get ... A documentation website needs to be set...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found