jaywcjlove / jaywcjlove/parcel-plugin-markdown-string

following README for getting HTML string didn't work for me

Open
#15 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
21
Forks
7
PR merge metrics
No merged PRs in 30d

Description

I only got markdown when I was trying to get HTML. By putting `console.log` statements in the code, I noticed that the default config had:
```
{ marked: undefined, html: undefined }
```

I ended up just doing an asset transformation, which is what originally looking for. Would be nice if how to do that were more clearly explained in the README. Here's the example I came up with that seems to work for me:
https://github.com/ultrasaurus/hello-parcel-markdown/tree/simple-asset-transform

basically, just needed to add `.markedrc` with
```
{
"marked": true,
"html": true
}

then `yarn parcel src/index.md`

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the README instructions for getting an HTML string and compare them with the working asset-transformation example linked in the issue. Verify the documented `.markedrc` settings and `yarn parcel src/index.md` command; done means a newcomer can follow the README to obtain HTML instead of only markdown.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.