mb21 / mb21/panwriter

Render HTML in Markdown Preview

Open
#59 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.3k
Forks
66
PR merge metrics
No merged PRs in 30d

Description

From what I can tell, PanWriter uses the following package to provide the preview pane to markdown files.

https://github.com/markdown-it/markdown-it#markdown-it

There is an option that can be toggled to true that allows HTML to be rendered.

Perhaps we could have a settings dialog to manage some of the default properties?

The latest version, running on Mac, doesn't seem to support it.

Here is my markdown:

image

The preview:

image

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the markdown-it documentation linked in the issue, then trace PanWriter's preview pane and its Markdown conversion entry point. Confirm how the current preview handles the supplied Markdown and HTML example. Done means supported HTML renders in the preview, with any settings-dialog scope clarified before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
electron, markdown, react, typescript
Domain
desktop, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.