Draft: Add an "allowHTML" feature for Markdoc #7582

alex-sherwin · 2023-07-05T20:28:44Z

Changes

Adds an allowHTML option for the @astrojs/markdoc integration which enables HTML tokenization/rendering in Markdoc markup

Testing

With extensive unit tests on parsed HTML DOM elements

Docs

changeset-bot · 2023-07-05T20:28:48Z

🦋 Changeset detected

Latest commit: 10e0eec

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

bholmesdev

Overall, very impressed with the thorough documentation and unit testing. Thanks for this! I've left some comments below, and have some general comments to address:

Folder structure: I'm not sure html belongs in extensions/, since it isn't applied using the extends configuration option. I think we can move html/ to the base src/ directory. I also think we can remove the 3rd-party/ directory; a code comment at the top denoting the source should be sufficient.
Attributing MIT licensed code: Speaking with core, I don't think "taken from" is the right verbage for these comments. I'm discussing with core how we can best attribute external code. I'll follow-up with a better answer!

packages/integrations/markdoc/test/render-html.test.js

packages/integrations/markdoc/package.json

...rc/extensions/html/htmlattributes/mutate-raw-html-attributes-to-react-compatible-variants.ts

packages/integrations/markdoc/src/extensions/html/transform/html-token-transform.ts

bholmesdev · 2023-07-07T11:25:41Z

Update: Here's our recommendation for citing external code!

When your licensed code only lives in a single file, I'd do a comment in that one file instead. /** @license MIT ${COPY-PASTE-THE-ENTIRE-LICENSE-HERE} */
either at the top of the file, or as close to the one snippet of code as possible.

This may seem excessive, though it makes guidelines clear for code usage. I'd use this in the files under 3rd-party/ and the react transforms.

@bholmesdev

This uses htmlparser2 to perform a pure token transform/mutation on the markdown-it tokens, replacing the original raw HTML string tokens with a richer set of tokens per HTML node, and in the process Markdoc tags are interleaved in the resulting token graph at the appropriate locations This removes the legacy config of the @astrojs/markdoc integration entirely (suggested by @bholmesdev) and introduces a new type for options to be specified in the astro config, initially, with just the new "enableHTML" option When "enableHTML" is *not* enabled (the default), the behavior of the entire @astrojs/markdoc integration should remain functionally equivalent to before this change

also: * cleaned up " to ' for astro project preferred linting * made the html rendering test fixture use a dynamic path

Co-authored-by: Bjorn Lu <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]>

Co-authored-by: Sarah Rainsberger <[email protected]>

… definition for html

* move out of extensions dir, remove export * cdata handling changes

* inline license from third party code * cleanup test class copy of HTML output * remove // third party indicators for imports (clarification: not third party code, just a indicator this group of imports is third party)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Runtime environment variables docs for node integration * Update packages/integrations/node/README.md Co-authored-by: Reuben Tier <[email protected]> * final fixes --------- Co-authored-by: Reuben Tier <[email protected]>

* docs: add docs link to markdoc error * docs: add named exports guide to README * chore: changeset * edit: no like so Co-authored-by: Chris Swithinbank <[email protected]> * edit: exposed as named exports Co-authored-by: Chris Swithinbank <[email protected]> --------- Co-authored-by: bholmesdev <[email protected]> Co-authored-by: Chris Swithinbank <[email protected]>

alex-sherwin · 2023-07-07T14:55:56Z

I really screwed up this branch with a rebase to fix my commit author info :)

I'll leave this repo up for short-term posterity but will open up a PR from a clean branch

bholmesdev · 2023-07-07T15:27:15Z

@alex-sherwin agh, just happened to me on a Markdoc release too. No problem, link when it's available!

alex-sherwin · 2023-07-07T17:13:49Z

@bholmesdev New PR is ready: #7597

github-actions bot added the pkg: integration Related to any renderer integration (scope) label Jul 5, 2023

bholmesdev reviewed Jul 6, 2023

View reviewed changes

alex-sherwin changed the title ~~Draft: Add an "enableHTML" feature for Markdoc~~ Draft: Add an "allowHTML" feature for Markdoc Jul 7, 2023

alex-sherwin and others added 25 commits July 7, 2023 10:49

7576 - fixed issues with whitespace preservation

ed7f32d

also: * cleaned up " to ' for astro project preferred linting * made the html rendering test fixture use a dynamic path

feat: vercel edge middleware support (#7532)

2028c74

Co-authored-by: Bjorn Lu <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]>

[ci] format

6e6b5ef

feat: astro info command (#7432)

2071bbf

Co-authored-by: Sarah Rainsberger <[email protected]>

[ci] format

6ad2e30

Refactor SSRResult and RenderContext (#7575)

5eec53a

7576 - detailed nested HTML test coverage

092440c

7576 - component + HTML interleaved tests

7d54d78

Update benchmark.yml

be171d3

corrected grammar. minor change (#7580)

ae31bfa

Simpify passing endpoint logging option (#7584)

5bdd2f1

Refactor passing compressHTML (#7585)

95095f8

7576 - fix lint problems from previous changes

f7a39e9

7576 - some commentary

987927b

7576 - file naming, refactor html under imports, package.json exports…

7b48420

… definition for html

7576

79aaf5f

* move out of extensions dir, remove export * cdata handling changes

7576

3f71818

* inline license from third party code * cleanup test class copy of HTML output * remove // third party indicators for imports (clarification: not third party code, just a indicator this group of imports is third party)

7576 - fixed test before/after for DRY'ness

a7f1e6e

7576 - no need to React-ify HTML attribute case

c09c0cb

[ci] release (#7578)

2c17f1a

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

docs(cloudflare): fix code snippet in enabling preview (#7591)

03239f1

Fix code snippet in markdoc README (#7592)

03fdf1a

7576 - rename "enableHTML" option to "allowHTML"

10e0eec

alex-sherwin closed this Jul 7, 2023

alex-sherwin mentioned this pull request Jul 7, 2023

Add "allowHTML" option for Markdoc with HTML parsing/processing #7597

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Draft: Add an "allowHTML" feature for Markdoc #7582

Draft: Add an "allowHTML" feature for Markdoc #7582

alex-sherwin commented Jul 5, 2023 •

edited

Loading

changeset-bot bot commented Jul 5, 2023 •

edited

Loading

bholmesdev left a comment

bholmesdev commented Jul 7, 2023

alex-sherwin commented Jul 7, 2023

bholmesdev commented Jul 7, 2023

alex-sherwin commented Jul 7, 2023 •

edited

Loading

Draft: Add an "allowHTML" feature for Markdoc #7582

Draft: Add an "allowHTML" feature for Markdoc #7582

Conversation

alex-sherwin commented Jul 5, 2023 • edited Loading

Changes

Testing

Docs

changeset-bot bot commented Jul 5, 2023 • edited Loading

🦋 Changeset detected

bholmesdev left a comment

Choose a reason for hiding this comment

bholmesdev commented Jul 7, 2023

alex-sherwin commented Jul 7, 2023

bholmesdev commented Jul 7, 2023

alex-sherwin commented Jul 7, 2023 • edited Loading

alex-sherwin commented Jul 5, 2023 •

edited

Loading

changeset-bot bot commented Jul 5, 2023 •

edited

Loading

alex-sherwin commented Jul 7, 2023 •

edited

Loading