NotePlan / NotePlan/plugins

Add HTML rendering of markdown notes

Open
#208 14 comments 0 reactions 2 assignees View on GitHub

@EduardMe is already working on this.

Since Jan 16, 2022.

enhancement P-7
Dominant language
JavaScript
Stars
204
Forks
82
Avg merge
22h 27m
Merged PRs (30d)
3

Description

A plugin should be able to create a React page inside a webview that can allow data in/out

Feels like Phase0 could be a webview that renders ReadOnly HTML (in a document or a split), ideally with an API that you can feed markdown to and it will render the HTML. This would have utility for reports and the like.

Then, making that WebView read/write is the goal. Pasting conversation from Discord:

dwertheimer — Yesterday at 1:57 PM
@Eduard I was thinking about your React/HTML in a webview pane idea and was thinking this would be a great solution to one of NP's biggest missing features -- tables. Would be awesome if you could have a MD doc underneath and a webview with the MD TABLE rendered in HTML (and editable in React/HTML with data passing back to the underlying NP Markdown doc). Typora does a pretty nice job of this (obviously would work differently in NP, but you get the idea).
table

Eduard — Today at 9:00 AM
Tables are possible with Swift, just a bit harder. But yes, a web view could solve that problem definitely faster. We have to think about the plugin structure first, however. How does a plugin provide the UI exactly. Maybe we could run a reactJS app inside a WebView simply.
Still we need to give that react js app the existing API to work with
Somehow
dwertheimer — Today at 9:03 AM
This is @codedungeon’s world ^^
NotePlan probably has to run a little web server
Eduard — Today at 9:21 AM
Not sure about that if its a ReactJS app, which is running no backend, only frontend, but I have no experience yet
codedungeon — Today at 9:30 AM
Q: What is the data source?
Q: Do you want to have read/write access to data?

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.