Compare commits

...

134 commits

Author SHA1 Message Date
Ben Holmes
5b1aa0e79a
nit: don't capitalize cc
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2023-03-03 13:07:07 -05:00
Ben Holmes
4d069ea22b
docs: with-mdx -> with-markdoc
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2023-03-03 13:06:35 -05:00
bholmesdev
93a30426b6 chore: clarify semi-private hooks 2023-03-03 12:13:24 -05:00
bholmesdev
1472697a8b chore: ignore statements 2023-03-03 12:08:02 -05:00
bholmesdev
36d12c1ab9 chore: lint 2023-03-03 11:42:41 -05:00
bholmesdev
bb6d871702 fix: forward slash. 2023-03-03 10:44:28 -05:00
bholmesdev
e881f67eb6 wip: forward slash?? 2023-03-03 10:10:54 -05:00
bholmesdev
d93f5242df chore: remove revealSecret from ex 2023-03-03 10:00:10 -05:00
bholmesdev
d6a03bfc99 fix: potentially unreliable cache 2023-03-03 09:59:41 -05:00
bholmesdev
989dcd44fd fix: cant find zod for some reason 2023-03-03 09:59:32 -05:00
bholmesdev
b703f4b654 chore: update DocsContent comments 2023-03-03 08:51:43 -05:00
bholmesdev
aabc064050 chore: update example coding challenge 2023-03-03 08:49:10 -05:00
bholmesdev
83611f33b2 docs: add editor integration 2023-03-03 08:42:49 -05:00
bholmesdev
6af17079ca docs: clarify Markdoc attributes 2023-03-03 08:42:49 -05:00
bholmesdev
11c5a781ed chore: update to nodes rec 2023-03-03 08:42:49 -05:00
bholmesdev
9e9a7ed482 docs: reshuffle note 2023-03-03 08:42:49 -05:00
bholmesdev
8e14143984 chore: clarify Markdoc config 2023-03-03 08:42:49 -05:00
bholmesdev
9bb1c29e98 test: update Markdoc node config test 2023-03-03 08:42:49 -05:00
bholmesdev
a628b264df chore: use error hint 2023-03-03 08:42:49 -05:00
bholmesdev
f50fcdd991 fix: handle possible cache miss 2023-03-03 08:42:49 -05:00
bholmesdev
eef9000b79 refactor: use MarkdocError on render errors 2023-03-03 08:42:49 -05:00
bholmesdev
9e2808c58c chore: validate tags and nodes 2023-03-03 08:42:49 -05:00
bholmesdev
8c348503fc chore: hand mjs highlighting in error overlay 2023-03-03 08:42:49 -05:00
bholmesdev
ad56cd95c8 chore: raise error if no matching component found 2023-03-03 08:42:49 -05:00
bholmesdev
833a88e439 chore: check components are capitalized names 2023-03-03 08:42:48 -05:00
bholmesdev
cbfa05f218 deps: zod 2023-03-03 08:42:48 -05:00
bholmesdev
32dda6230e fix: indentation 2023-03-03 08:42:48 -05:00
bholmesdev
6cdf8cf243 fix: inconsistent tabs v spaces 2023-03-03 08:42:48 -05:00
bholmesdev
78ff16b8e8 docs: add separate HTML and component examples 2023-03-03 08:42:48 -05:00
bholmesdev
5d9d5ffb71 nit: add "today" to imply future support 2023-03-03 08:42:48 -05:00
bholmesdev
a4d1c0fa49 edit: add client component instructions 2023-03-03 08:42:48 -05:00
bholmesdev
c31bcc5918 docs: astro-ui-frameworks -> astro-components 2023-03-03 08:42:48 -05:00
bholmesdev
1f72257abe docs: update config to new Markdoc options 2023-03-03 08:42:48 -05:00
bholmesdev
a3a187b6d3 docs: query for -> query your collection 2023-03-03 08:42:48 -05:00
bholmesdev
35cd0630c5 docs: add "exclusively" to README 2023-03-03 08:42:48 -05:00
bholmesdev
a72a1dbda1 chore: with-markdoc filetree 2023-03-03 08:42:48 -05:00
bholmesdev
97950729e9 test: update fixture to match new config 2023-03-03 08:42:48 -05:00
bholmesdev
de9784aa07 refactor: remove advanced component API 2023-03-03 08:42:48 -05:00
bholmesdev
cdf45e8e42 refactor: remove Markdoc export 2023-03-03 08:42:48 -05:00
bholmesdev
6193f994f1 chore: use Markdoc terms for transform 2023-03-03 08:42:48 -05:00
Ben Holmes
14760a37ba docs: only used in content collections
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2023-03-03 08:42:48 -05:00
bholmesdev
d66ee0dcd0 refactor: move markdoc transform to build time 2023-03-03 08:42:48 -05:00
bholmesdev
c7e4236ed7 chore: add --format flag to benchmark 2023-03-03 08:42:48 -05:00
bholmesdev
3bd8920a25 feat: add react-component render benchmark 2023-03-03 08:42:48 -05:00
bholmesdev
782c3fc417 chore: remove accidental file 2023-03-03 08:42:48 -05:00
bholmesdev
b573e53e9c refactor: ASTRO_CI_PERFORMANCE_RUN -> ASTRO_PERFORMANCE_BENCHMARK 2023-03-03 08:42:48 -05:00
bholmesdev
79d30b1f31 chore: remove old --internal-ci reference 2023-03-03 08:42:47 -05:00
bholmesdev
e7c926212f feat: test simple and with-components cases 2023-03-03 08:42:47 -05:00
bholmesdev
51824a9b51 chore: refine generated ignore 2023-03-03 08:42:47 -05:00
bholmesdev
b73e8f0899 refactor: isPerfBenchmark 2023-03-03 08:42:47 -05:00
bholmesdev
d8f664c807 feat: add perf benchmark check to mdx 2023-03-03 08:42:47 -05:00
bholmesdev
8677aa8392 refactor: --perf -> env var 2023-03-03 08:42:47 -05:00
bholmesdev
34dbdad186 chore: log ext and directory on write 2023-03-03 08:42:07 -05:00
bholmesdev
c20e1b6601 refactor: --perf -> --internal-ci-perf 2023-03-03 08:42:07 -05:00
bholmesdev
2138abf683 chore: remove .astro types from remote 2023-03-03 08:42:07 -05:00
bholmesdev
b1c432d6c0 chore: lockfile 2023-03-03 08:42:00 -05:00
bholmesdev
5a378df6d1 chore: remove generated files from git 2023-03-03 08:42:00 -05:00
bholmesdev
83e475b1e3 chore: mdoc and mdx fixtures 2023-03-03 08:41:59 -05:00
bholmesdev
685ac9e140 deps: npm-run-all 2023-03-03 08:41:59 -05:00
bholmesdev
5e5668f6bc refactor: generate posts instead of commiting 2023-03-03 08:41:59 -05:00
bholmesdev
025eaad791 refactor: move rendering to util 2023-03-03 08:41:58 -05:00
bholmesdev
6fd4c9ac38 wip: performance pkg with md fixture 2023-03-03 08:41:58 -05:00
bholmesdev
04facd1683 feat: add --perf flag to skip md plugins 2023-03-03 08:41:58 -05:00
bholmesdev
6e18764e48 Squashed commit of markdoc-poc
commit bd0dd9d71938da22f596ddd1662d9b91707f80c7
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 15 09:43:04 2023 -0500

    Revert "feat: support `.md` overrides for content collections"

    This reverts commit c06f83ef85.

commit 5b9a1f33f4d0ffd4a63a81a86652fee032b75d76
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 13:48:56 2023 -0500

    feat: generate `.md` types override

commit e464ae894ed69cf492de1d3e8018d9a17c00d7a3
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:56:11 2023 -0500

    chore: mdoc -> md

commit b74fd6a7d6b973b2bfd9b2ab9567801ff4d7fec1
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:56:01 2023 -0500

    feat: support `.md` overrides for content collections

commit bdcc18a7c03e3524927ba7c1b18ad2fd80a2e994
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:30:48 2023 -0500

    deps: remove html-escaper

commit f44b57f0fa2ac923a3f2a46471fda710e92d5824
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:30:42 2023 -0500

    fix: remove unneeded html-escaper

commit fb7919498aca6beded444ed5922f3598d244d30c
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:08:04 2023 -0500

    fix: type inferencing in preview

commit 0c05034b321a82f2f054b527538d57f45f096822
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 11:32:19 2023 -0500

    fix: import types from @astrojs/markdoc

commit 57e741a6306b801ac4ce47f20f7664518359611d
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 11:28:33 2023 -0500

    refactor: remove unneeded async

commit b19d85451e60da281bc32a2a180452987a049479
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 10:26:20 2023 -0500

    fix: lock

commit b1083a14f9fefe5e7a9f2a8c7c31626a7430c851
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 10:19:50 2023 -0500

    nit: 0.0.0 to avoid version bump

commit 71891ebe9dd54b495e965bf064ee78aaca9dfede
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:33:27 2023 -0500

    chore: changeset

commit 444752a5e27c4f5bda54ac024eca9a7ab1c4563f
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:30:10 2023 -0500

    docs: add note on Aside src

commit 619d4b3fdf02cc34ea3f8f9a0b4d93db273bb0a1
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:25:56 2023 -0500

    nit: reorder type import

commit e914da05706382b17e1b8f3404fc2852002a5dc7
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:25:38 2023 -0500

    refactor: clean up astroNode

commit 2dfc226f56dc6a9e3e3ace72d4c3889a1fde4e6d
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:08:56 2023 -0500

    docs: README edits

commit 3c7b85c7d9e3c75d551baf33aba9a646d0d61cba
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:07:29 2023 -0500

    docs: change with-markdoc title

commit 29cdea9a0be439b631389cbc906751185489cbe9
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:29:10 2023 -0500

    docs: add usage and examples to Markdoc README

commit e397a80179e9bd934ef8875155d7491b1d4e077a
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:18:54 2023 -0500

    fix: line endings in test

commit f9ebf59982fa7dc1202368da344897f54de7f259
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:09:15 2023 -0500

    docs: @astrojs/markdoc README intro

commit 7800e9c9dac946f89e139b200a0083b53942118d
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:08:07 2023 -0500

    docs: update example README

commit f0b900a6fa7f0775dfab7600c4fb04c9b64e7439
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:04:34 2023 -0500

    chore: remove markdoc.config loader

commit 3f040e44d0c639dc51976abe75f46c57f0be60fc
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 17:58:52 2023 -0500

    chore: remove unused fixture dep

commit b2ea6c26df6acf1df8f06d2feb9c91da8c8eafae
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 17:58:25 2023 -0500

    fix: glob for single content extension

commit f4e171c05c421f8696ebc406c9d4d28967f80690
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 15:10:39 2023 -0500

    chore: remove unused deps

commit d9095d0284b0fc22d5da367771bc5286eb8f1926
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 15:10:31 2023 -0500

    chore: unused style tag

commit a5435f13575577bf6a954c68eef9e883959568dc
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 15:08:52 2023 -0500

    chore: clean up Markdoc starter to essentials

commit 815e2f2bad5617ab077d278d7c751f34c22dd0d9
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 14:13:02 2023 -0500

    feat: content prop types for markdoc!

commit 8bcd23c4e70b4900b16ebf5a30dad6ec998f4092
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 14:05:40 2023 -0500

    feat: allow Render type injection

commit cdb7e9e4878888c0883d4082d2415f4d85050389
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 14:04:37 2023 -0500

    chore: unused file

commit 0df33ea37d4ca9bd933be54d7f8b455fce174679
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 14:04:31 2023 -0500

    chore: with-markdoc strictNullChecks

commit 377c6d766bd51469f09e1f946a1c2b77affe6620
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 17:39:35 2023 -0500

    play: add docs example with Aside and Since ported

commit f9f811257167da7a5e05a7de3a12b58e7b3568b1
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:22:47 2023 -0500

    chore: remove unused options object

commit c9a66bfeb0ce55ef0a1c0c6ed2da746d5250c795
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:18:27 2023 -0500

    chore: remove content-types. Too early!

commit 67f49e86a980c5d858ad0e384bdc67fad5e096e6
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:18:20 2023 -0500

    fix: ContentEntryType import

commit 9b93d8189213a12346520fa8a71eae824386ad3e
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:10:06 2023 -0500

    chore: Markdoc working! log

commit 90f77645ef3985fbba1badeb4413759626290b1a
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:09:58 2023 -0500

    test: content component dev and build

commit 14559f6a40af63106cebeba210e73392d5d1c37d
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:01:10 2023 -0500

    test: prod builds

commit a0dcbff73cf8b3cf9b55434a8fb2b0b683903c5f
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:01:04 2023 -0500

    fix: stop bundling markdoc for isTag

commit cb1904876f074c50c206131e9588878230bbab47
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:00:53 2023 -0500

    fix: avoid import if no config present (prod build error)

commit bda8295e7920638c013875ab9fe31ce87743c95f
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:00:33 2023 -0500

    chore: ignore `.astro` type error

commit 28a6d7993a227c68aeca747661254ff68883244a
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:00:12 2023 -0500

    fix: remove "components" from tsconfig

commit 0297bb749599aa8063e685a7ece738afe3ae77cc
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:00:01 2023 -0500

    deps: add shiki for Code comp error

commit e4f141e558b3d76b761bec69e694eaa40cdf250d
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 08:45:37 2023 -0500

    play: make sure md also works

commit dfdb35f0888ee83457ee825172f7d8485b7d2a43
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 13:25:18 2023 -0500

    test: entry and collections parse

commit eaf4994bf309955209f406d7db0863775fdf4fe0
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 13:25:07 2023 -0500

    deps: devalue, test fixture

commit 3f71932c04f8064cfe74b7f4b02409c681925e4a
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 13:24:47 2023 -0500

    chore: remove unused dream file

commit b182686f88878cdf003efba798edb69372872b21
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:29:32 2023 -0500

    refactor: remove fallback loader

commit 0540d701ccb33db7a82be861c36dcafec0dbbb81
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:26:21 2023 -0500

    fix: markdoc.config loading

commit 575dadf70e7b5aa263e30c8b496a1cceebd31bb4
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:16:18 2023 -0500

    oops, forgot to commit untracked

commit 9746a97bc2dfcf63bfd685f541ffbd229ea134ca
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:16:02 2023 -0500

    refactor: pass file contents

commit 534a658325cbddbb153bea1c1338d13011eb0e4f
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:13:38 2023 -0500

    refactor: move plain md to content entry type

commit 24df79b1475c12ccefaadb2392e9d5911c491872
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 15:51:44 2023 -0500

    wip: move mdx to collection type API

commit cc44e4fa3453353041fdbe9424d96040f93f28a7
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 15:50:52 2023 -0500

    deps: mdx

commit c30c1b3dcf6da3a075c1f07260ae893ef93e07e2
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 10:10:39 2023 -0500

    wip: scaffold content types

commit 2487aedf9deb74a5725ba8393766b68f60b74af8
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 09:53:35 2023 -0500

    feat: move Renderer to markdoc, get Content component!

commit 44faff911b8de6f6da45f195dad0a56a426b076e
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 09:53:06 2023 -0500

    deps: move to @astrojs/markdoc

commit bef26906f3f2f1104b88332778ee219cf062fe88
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 7 16:01:34 2023 -0500

    feat: addContentEntryType integration hook

commit 508568f5117a56fc4ef14db9d0482cdfcfe5007d
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 7 16:00:42 2023 -0500

    deps: graymatter

commit cb706020391b4b61f3854b3e9a9d9190a94785c9
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 7 14:00:27 2023 -0500

    chore: unit tests

commit 545246d15362b8f981f8c315d3b7d0341626eeb8
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 7 14:00:23 2023 -0500

    wip: get dream API for file loader working

commit 97664e0f862f7f6e0c9ce8478b3bed58432f6426
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 18:09:23 2023 -0500

    wip: play with separate markdoc config

commit c5d8a3336cc9f5dd7b4115b7f86fdb86474ca462
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 17:04:22 2023 -0500

    fix: render attributes to html

commit 82e30a0083b20c85307726027ee7e74df7378632
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 17:04:14 2023 -0500

    deps: stringify-attributes

commit b72ba6167db88d5042eee51d5912d4270417bca5
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 16:33:27 2023 -0500

    fix: component render bug

commit 59f1e5c6f89d2c7457a0b0e0acb838bf945d39bf
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 16:11:15 2023 -0500

    feat: basic Astro renderer in with-markdoc

commit de15a7213d9afbc94dd0e50f713c9a02dc8e90e5
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 16:11:01 2023 -0500

    wip: expose Markdoc from integration

commit 83bfe4441b652a7eb880486785dc2c5eda08e3b3
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 11:21:17 2023 -0500

    feat: get markdoc contents

commit 6f500689a00b8f8c2151254930fda24e0b3e4207
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 11:13:57 2023 -0500

    chore: integration setup
2023-03-03 08:41:39 -05:00
bholmesdev
1021c3a3dd Squashed commit of markdoc-poc
commit bd0dd9d71938da22f596ddd1662d9b91707f80c7
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 15 09:43:04 2023 -0500

    Revert "feat: support `.md` overrides for content collections"

    This reverts commit c06f83ef85.

commit 5b9a1f33f4d0ffd4a63a81a86652fee032b75d76
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 13:48:56 2023 -0500

    feat: generate `.md` types override

commit e464ae894ed69cf492de1d3e8018d9a17c00d7a3
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:56:11 2023 -0500

    chore: mdoc -> md

commit b74fd6a7d6b973b2bfd9b2ab9567801ff4d7fec1
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:56:01 2023 -0500

    feat: support `.md` overrides for content collections

commit bdcc18a7c03e3524927ba7c1b18ad2fd80a2e994
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:30:48 2023 -0500

    deps: remove html-escaper

commit f44b57f0fa2ac923a3f2a46471fda710e92d5824
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:30:42 2023 -0500

    fix: remove unneeded html-escaper

commit fb7919498aca6beded444ed5922f3598d244d30c
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 12:08:04 2023 -0500

    fix: type inferencing in preview

commit 0c05034b321a82f2f054b527538d57f45f096822
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 11:32:19 2023 -0500

    fix: import types from @astrojs/markdoc

commit 57e741a6306b801ac4ce47f20f7664518359611d
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 11:28:33 2023 -0500

    refactor: remove unneeded async

commit b19d85451e60da281bc32a2a180452987a049479
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 10:26:20 2023 -0500

    fix: lock

commit b1083a14f9fefe5e7a9f2a8c7c31626a7430c851
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 10:19:50 2023 -0500

    nit: 0.0.0 to avoid version bump

commit 71891ebe9dd54b495e965bf064ee78aaca9dfede
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:33:27 2023 -0500

    chore: changeset

commit 444752a5e27c4f5bda54ac024eca9a7ab1c4563f
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:30:10 2023 -0500

    docs: add note on Aside src

commit 619d4b3fdf02cc34ea3f8f9a0b4d93db273bb0a1
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:25:56 2023 -0500

    nit: reorder type import

commit e914da05706382b17e1b8f3404fc2852002a5dc7
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:25:38 2023 -0500

    refactor: clean up astroNode

commit 2dfc226f56dc6a9e3e3ace72d4c3889a1fde4e6d
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:08:56 2023 -0500

    docs: README edits

commit 3c7b85c7d9e3c75d551baf33aba9a646d0d61cba
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 14 09:07:29 2023 -0500

    docs: change with-markdoc title

commit 29cdea9a0be439b631389cbc906751185489cbe9
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:29:10 2023 -0500

    docs: add usage and examples to Markdoc README

commit e397a80179e9bd934ef8875155d7491b1d4e077a
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:18:54 2023 -0500

    fix: line endings in test

commit f9ebf59982fa7dc1202368da344897f54de7f259
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:09:15 2023 -0500

    docs: @astrojs/markdoc README intro

commit 7800e9c9dac946f89e139b200a0083b53942118d
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:08:07 2023 -0500

    docs: update example README

commit f0b900a6fa7f0775dfab7600c4fb04c9b64e7439
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 18:04:34 2023 -0500

    chore: remove markdoc.config loader

commit 3f040e44d0c639dc51976abe75f46c57f0be60fc
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 17:58:52 2023 -0500

    chore: remove unused fixture dep

commit b2ea6c26df6acf1df8f06d2feb9c91da8c8eafae
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 17:58:25 2023 -0500

    fix: glob for single content extension

commit f4e171c05c421f8696ebc406c9d4d28967f80690
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 15:10:39 2023 -0500

    chore: remove unused deps

commit d9095d0284b0fc22d5da367771bc5286eb8f1926
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 15:10:31 2023 -0500

    chore: unused style tag

commit a5435f13575577bf6a954c68eef9e883959568dc
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 15:08:52 2023 -0500

    chore: clean up Markdoc starter to essentials

commit 815e2f2bad5617ab077d278d7c751f34c22dd0d9
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 14:13:02 2023 -0500

    feat: content prop types for markdoc!

commit 8bcd23c4e70b4900b16ebf5a30dad6ec998f4092
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 14:05:40 2023 -0500

    feat: allow Render type injection

commit cdb7e9e4878888c0883d4082d2415f4d85050389
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 14:04:37 2023 -0500

    chore: unused file

commit 0df33ea37d4ca9bd933be54d7f8b455fce174679
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 13 14:04:31 2023 -0500

    chore: with-markdoc strictNullChecks

commit 377c6d766bd51469f09e1f946a1c2b77affe6620
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 17:39:35 2023 -0500

    play: add docs example with Aside and Since ported

commit f9f811257167da7a5e05a7de3a12b58e7b3568b1
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:22:47 2023 -0500

    chore: remove unused options object

commit c9a66bfeb0ce55ef0a1c0c6ed2da746d5250c795
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:18:27 2023 -0500

    chore: remove content-types. Too early!

commit 67f49e86a980c5d858ad0e384bdc67fad5e096e6
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:18:20 2023 -0500

    fix: ContentEntryType import

commit 9b93d8189213a12346520fa8a71eae824386ad3e
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:10:06 2023 -0500

    chore: Markdoc working! log

commit 90f77645ef3985fbba1badeb4413759626290b1a
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:09:58 2023 -0500

    test: content component dev and build

commit 14559f6a40af63106cebeba210e73392d5d1c37d
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:01:10 2023 -0500

    test: prod builds

commit a0dcbff73cf8b3cf9b55434a8fb2b0b683903c5f
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:01:04 2023 -0500

    fix: stop bundling markdoc for isTag

commit cb1904876f074c50c206131e9588878230bbab47
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:00:53 2023 -0500

    fix: avoid import if no config present (prod build error)

commit bda8295e7920638c013875ab9fe31ce87743c95f
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:00:33 2023 -0500

    chore: ignore `.astro` type error

commit 28a6d7993a227c68aeca747661254ff68883244a
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:00:12 2023 -0500

    fix: remove "components" from tsconfig

commit 0297bb749599aa8063e685a7ece738afe3ae77cc
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 09:00:01 2023 -0500

    deps: add shiki for Code comp error

commit e4f141e558b3d76b761bec69e694eaa40cdf250d
Author: bholmesdev <hey@bholmes.dev>
Date:   Fri Feb 10 08:45:37 2023 -0500

    play: make sure md also works

commit dfdb35f0888ee83457ee825172f7d8485b7d2a43
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 13:25:18 2023 -0500

    test: entry and collections parse

commit eaf4994bf309955209f406d7db0863775fdf4fe0
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 13:25:07 2023 -0500

    deps: devalue, test fixture

commit 3f71932c04f8064cfe74b7f4b02409c681925e4a
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 13:24:47 2023 -0500

    chore: remove unused dream file

commit b182686f88878cdf003efba798edb69372872b21
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:29:32 2023 -0500

    refactor: remove fallback loader

commit 0540d701ccb33db7a82be861c36dcafec0dbbb81
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:26:21 2023 -0500

    fix: markdoc.config loading

commit 575dadf70e7b5aa263e30c8b496a1cceebd31bb4
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:16:18 2023 -0500

    oops, forgot to commit untracked

commit 9746a97bc2dfcf63bfd685f541ffbd229ea134ca
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:16:02 2023 -0500

    refactor: pass file contents

commit 534a658325cbddbb153bea1c1338d13011eb0e4f
Author: bholmesdev <hey@bholmes.dev>
Date:   Thu Feb 9 12:13:38 2023 -0500

    refactor: move plain md to content entry type

commit 24df79b1475c12ccefaadb2392e9d5911c491872
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 15:51:44 2023 -0500

    wip: move mdx to collection type API

commit cc44e4fa3453353041fdbe9424d96040f93f28a7
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 15:50:52 2023 -0500

    deps: mdx

commit c30c1b3dcf6da3a075c1f07260ae893ef93e07e2
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 10:10:39 2023 -0500

    wip: scaffold content types

commit 2487aedf9deb74a5725ba8393766b68f60b74af8
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 09:53:35 2023 -0500

    feat: move Renderer to markdoc, get Content component!

commit 44faff911b8de6f6da45f195dad0a56a426b076e
Author: bholmesdev <hey@bholmes.dev>
Date:   Wed Feb 8 09:53:06 2023 -0500

    deps: move to @astrojs/markdoc

commit bef26906f3f2f1104b88332778ee219cf062fe88
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 7 16:01:34 2023 -0500

    feat: addContentEntryType integration hook

commit 508568f5117a56fc4ef14db9d0482cdfcfe5007d
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 7 16:00:42 2023 -0500

    deps: graymatter

commit cb706020391b4b61f3854b3e9a9d9190a94785c9
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 7 14:00:27 2023 -0500

    chore: unit tests

commit 545246d15362b8f981f8c315d3b7d0341626eeb8
Author: bholmesdev <hey@bholmes.dev>
Date:   Tue Feb 7 14:00:23 2023 -0500

    wip: get dream API for file loader working

commit 97664e0f862f7f6e0c9ce8478b3bed58432f6426
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 18:09:23 2023 -0500

    wip: play with separate markdoc config

commit c5d8a3336cc9f5dd7b4115b7f86fdb86474ca462
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 17:04:22 2023 -0500

    fix: render attributes to html

commit 82e30a0083b20c85307726027ee7e74df7378632
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 17:04:14 2023 -0500

    deps: stringify-attributes

commit b72ba6167db88d5042eee51d5912d4270417bca5
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 16:33:27 2023 -0500

    fix: component render bug

commit 59f1e5c6f89d2c7457a0b0e0acb838bf945d39bf
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 16:11:15 2023 -0500

    feat: basic Astro renderer in with-markdoc

commit de15a7213d9afbc94dd0e50f713c9a02dc8e90e5
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 16:11:01 2023 -0500

    wip: expose Markdoc from integration

commit 83bfe4441b652a7eb880486785dc2c5eda08e3b3
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 11:21:17 2023 -0500

    feat: get markdoc contents

commit 6f500689a00b8f8c2151254930fda24e0b3e4207
Author: bholmesdev <hey@bholmes.dev>
Date:   Mon Feb 6 11:13:57 2023 -0500

    chore: integration setup
2023-03-03 08:41:01 -05:00
bholmesdev
9e45239133 Revert "feat: support .md overrides for content collections"
This reverts commit c06f83ef85.
2023-03-03 08:39:41 -05:00
bholmesdev
ed2b7b6cd4 feat: generate .md types override 2023-03-03 08:39:41 -05:00
bholmesdev
7d201b9a46 chore: mdoc -> md 2023-03-03 08:39:41 -05:00
bholmesdev
5aebbd88ca feat: support .md overrides for content collections 2023-03-03 08:39:41 -05:00
bholmesdev
d049a48cf1 deps: remove html-escaper 2023-03-03 08:39:41 -05:00
bholmesdev
af68496777 fix: remove unneeded html-escaper 2023-03-03 08:39:41 -05:00
bholmesdev
8abca5cba0 fix: type inferencing in preview 2023-03-03 08:39:41 -05:00
bholmesdev
a609356958 fix: import types from @astrojs/markdoc 2023-03-03 08:39:41 -05:00
bholmesdev
dfcf10bbc2 refactor: remove unneeded async 2023-03-03 08:39:41 -05:00
bholmesdev
61ceb11fb4 fix: lock 2023-03-03 08:39:41 -05:00
bholmesdev
937f7ad7c8 nit: 0.0.0 to avoid version bump 2023-03-03 08:39:41 -05:00
bholmesdev
d283be6761 chore: changeset 2023-03-03 08:39:41 -05:00
bholmesdev
04e456e3bb docs: add note on Aside src 2023-03-03 08:39:41 -05:00
bholmesdev
9fd6156ce1 nit: reorder type import 2023-03-03 08:39:41 -05:00
bholmesdev
474250815e refactor: clean up astroNode 2023-03-03 08:39:41 -05:00
bholmesdev
cb89b73191 docs: README edits 2023-03-03 08:39:41 -05:00
bholmesdev
aa01a2c512 docs: change with-markdoc title 2023-03-03 08:39:41 -05:00
bholmesdev
870b5e1834 docs: add usage and examples to Markdoc README 2023-03-03 08:39:41 -05:00
bholmesdev
e6dd75910f fix: line endings in test 2023-03-03 08:39:41 -05:00
bholmesdev
fc7f50cecc docs: @astrojs/markdoc README intro 2023-03-03 08:39:41 -05:00
bholmesdev
9365aadc3b docs: update example README 2023-03-03 08:39:41 -05:00
bholmesdev
af4ea22836 chore: remove markdoc.config loader 2023-03-03 08:39:41 -05:00
bholmesdev
bdcc67fc37 chore: remove unused fixture dep 2023-03-03 08:39:40 -05:00
bholmesdev
047a52c1bd fix: glob for single content extension 2023-03-03 08:39:40 -05:00
bholmesdev
03525734ac chore: remove unused deps 2023-03-03 08:39:40 -05:00
bholmesdev
12cdbcd967 chore: unused style tag 2023-03-03 08:39:40 -05:00
bholmesdev
fbe100a70e chore: clean up Markdoc starter to essentials 2023-03-03 08:39:40 -05:00
bholmesdev
f6cf48a806 feat: content prop types for markdoc! 2023-03-03 08:39:40 -05:00
bholmesdev
3a2a829236 feat: allow Render type injection 2023-03-03 08:39:40 -05:00
bholmesdev
7cc28032c2 chore: unused file 2023-03-03 08:39:40 -05:00
bholmesdev
5371403734 chore: with-markdoc strictNullChecks 2023-03-03 08:39:40 -05:00
bholmesdev
f9bd8125fb play: add docs example with Aside and Since ported 2023-03-03 08:39:40 -05:00
bholmesdev
f3e23ddf47 chore: remove unused options object 2023-03-03 08:39:40 -05:00
bholmesdev
a89453c335 chore: remove content-types. Too early! 2023-03-03 08:39:40 -05:00
bholmesdev
f72d03c62e fix: ContentEntryType import 2023-03-03 08:39:40 -05:00
bholmesdev
50fea0b7ae chore: Markdoc working! log 2023-03-03 08:39:40 -05:00
bholmesdev
f3bdf9e0f4 test: content component dev and build 2023-03-03 08:39:40 -05:00
bholmesdev
4312d6df11 test: prod builds 2023-03-03 08:39:40 -05:00
bholmesdev
b53b3ba84f fix: stop bundling markdoc for isTag 2023-03-03 08:39:40 -05:00
bholmesdev
9c5d41959d fix: avoid import if no config present (prod build error) 2023-03-03 08:39:40 -05:00
bholmesdev
a6cbf7b7e1 chore: ignore .astro type error 2023-03-03 08:39:40 -05:00
bholmesdev
624c851e58 fix: remove "components" from tsconfig 2023-03-03 08:39:40 -05:00
bholmesdev
ff611250d9 deps: add shiki for Code comp error 2023-03-03 08:39:39 -05:00
bholmesdev
319d5945c2 play: make sure md also works 2023-03-03 08:39:38 -05:00
bholmesdev
328bfdc50f test: entry and collections parse 2023-03-03 08:39:38 -05:00
bholmesdev
0f13ea26e5 deps: devalue, test fixture 2023-03-03 08:39:38 -05:00
bholmesdev
24cabf10f0 chore: remove unused dream file 2023-03-03 08:39:37 -05:00
bholmesdev
57b36498fd refactor: remove fallback loader 2023-03-03 08:39:37 -05:00
bholmesdev
8beb9680cb fix: markdoc.config loading 2023-03-03 08:39:37 -05:00
bholmesdev
677ed58456 oops, forgot to commit untracked 2023-03-03 08:39:37 -05:00
bholmesdev
49d9972e88 refactor: pass file contents 2023-03-03 08:39:37 -05:00
bholmesdev
61723b5269 refactor: move plain md to content entry type 2023-03-03 08:39:37 -05:00
bholmesdev
85e49304c7 wip: move mdx to collection type API 2023-03-03 08:39:37 -05:00
bholmesdev
8818f58b72 deps: mdx 2023-03-03 08:39:37 -05:00
bholmesdev
8690c522cf wip: scaffold content types 2023-03-03 08:39:37 -05:00
bholmesdev
abe1d40ba8 feat: move Renderer to markdoc, get Content component! 2023-03-03 08:39:37 -05:00
bholmesdev
a15c2fbd97 deps: move to @astrojs/markdoc 2023-03-03 08:39:37 -05:00
bholmesdev
9f589a9c4b feat: addContentEntryType integration hook 2023-03-03 08:39:37 -05:00
bholmesdev
4347ac3fef deps: graymatter 2023-03-03 08:39:37 -05:00
bholmesdev
3238a55c6a chore: unit tests 2023-03-03 08:39:37 -05:00
bholmesdev
80dd10cbe3 wip: get dream API for file loader working 2023-03-03 08:39:37 -05:00
bholmesdev
7d0a6b8042 wip: play with separate markdoc config 2023-03-03 08:39:37 -05:00
bholmesdev
fa52eb4844 fix: render attributes to html 2023-03-03 08:39:37 -05:00
bholmesdev
5b1492eb82 deps: stringify-attributes 2023-03-03 08:39:37 -05:00
bholmesdev
e141dc9da9 fix: component render bug 2023-03-03 08:39:37 -05:00
bholmesdev
a6920f2705 feat: basic Astro renderer in with-markdoc 2023-03-03 08:39:37 -05:00
bholmesdev
41275d2521 wip: expose Markdoc from integration 2023-03-03 08:39:37 -05:00
bholmesdev
36f2f01d6d feat: get markdoc contents 2023-03-03 08:39:37 -05:00
bholmesdev
f49f2cca6b chore: integration setup 2023-03-03 08:39:37 -05:00
103 changed files with 24769 additions and 135 deletions

View file

@ -0,0 +1,7 @@
---
'astro': patch
'@astrojs/markdoc': patch
'@astrojs/mdx': patch
---
Introduce the (experimental) `@astrojs/markdoc` integration. This unlocks Markdoc inside your Content Collections, and brings support for Astro and UI components in your content. This also improves internals to make Content Collections extensible to more file types in the future.

21
examples/with-markdoc/.gitignore vendored Normal file
View file

@ -0,0 +1,21 @@
# build output
dist/
# generated types
.astro/
# dependencies
node_modules/
# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
# environment variables
.env
.env.production
# macOS-specific files
.DS_Store

View file

@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}

View file

@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}

View file

@ -0,0 +1,59 @@
# Astro Example: Markdoc (experimental)
This starter showcases the experimental Markdoc integration.
```
npm create astro@latest -- --template with-markdoc
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdoc)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-markdoc)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```
/
├── public/
├── src/
│ └── content/
└── docs/
│ └── intro.mdoc
| └── config.ts
│ └── components/
| ├── Aside.astro
│ └── DocsContent.astro
│ └── layouts/
│ └── Layout.astro
│ └── pages/
│ └── index.astro
| └── env.d.ts
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.json
```
Markdoc can be used in content collections _exclusively_ with the `.mdoc` extension. See `content/docs/` for an example file.
You can also apply Astro components and server-rendered UI components (React, Vue, Svelte, etc) to your Markdoc files. See `src/content/DocsContent.astro` for an example.
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).

View file

@ -0,0 +1,19 @@
import { defineConfig } from 'astro/config';
import markdoc from '@astrojs/markdoc';
// https://astro.build/config
export default defineConfig({
integrations: [
markdoc({
tags: {
aside: {
render: 'Aside',
attributes: {
type: { type: String },
title: { type: String },
},
},
},
}),
],
});

View file

@ -0,0 +1,17 @@
{
"name": "@example/with-markdoc",
"type": "module",
"version": "0.0.1",
"private": true,
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
},
"dependencies": {
"@astrojs/markdoc": "^0.0.0",
"astro": "^2.0.6"
}
}

View file

@ -0,0 +1,13 @@
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 36 36">
<path fill="#000" d="M22.25 4h-8.5a1 1 0 0 0-.96.73l-5.54 19.4a.5.5 0 0 0 .62.62l5.05-1.44a2 2 0 0 0 1.38-1.4l3.22-11.66a.5.5 0 0 1 .96 0l3.22 11.67a2 2 0 0 0 1.38 1.39l5.05 1.44a.5.5 0 0 0 .62-.62l-5.54-19.4a1 1 0 0 0-.96-.73Z"/>
<path fill="url(#gradient)" d="M18 28a7.63 7.63 0 0 1-5-2c-1.4 2.1-.35 4.35.6 5.55.14.17.41.07.47-.15.44-1.8 2.93-1.22 2.93.6 0 2.28.87 3.4 1.72 3.81.34.16.59-.2.49-.56-.31-1.05-.29-2.46 1.29-3.25 3-1.5 3.17-4.83 2.5-6-.67.67-2.6 2-5 2Z"/>
<defs>
<linearGradient id="gradient" x1="16" x2="16" y1="32" y2="24" gradientUnits="userSpaceOnUse">
<stop stop-color="#000"/>
<stop offset="1" stop-color="#000" stop-opacity="0"/>
</linearGradient>
</defs>
<style>
@media (prefers-color-scheme:dark){:root{filter:invert(100%)}}
</style>
</svg>

After

Width:  |  Height:  |  Size: 873 B

View file

@ -0,0 +1,11 @@
{
"infiniteLoopProtection": true,
"hardReloadOnChange": false,
"view": "browser",
"template": "node",
"container": {
"port": 3000,
"startScript": "start",
"node": "14"
}
}

View file

@ -0,0 +1,116 @@
---
// Inspired by the `Aside` component from docs.astro.build
// https://github.com/withastro/docs/blob/main/src/components/Aside.astro
export interface Props {
type?: 'note' | 'tip' | 'caution' | 'danger';
title?: string;
}
const labelByType = {
note: 'Note',
tip: 'Tip',
caution: 'Caution',
danger: 'Danger',
};
const { type = 'note' } = Astro.props as Props;
const title = Astro.props.title ?? labelByType[type] ?? '';
// SVG icon paths based on GitHub Octicons
const icons: Record<NonNullable<Props['type']>, { viewBox: string; d: string }> = {
note: {
viewBox: '0 0 18 18',
d: 'M0 3.75C0 2.784.784 2 1.75 2h12.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0114.25 14H1.75A1.75 1.75 0 010 12.25v-8.5zm1.75-.25a.25.25 0 00-.25.25v8.5c0 .138.112.25.25.25h12.5a.25.25 0 00.25-.25v-8.5a.25.25 0 00-.25-.25H1.75zM3.5 6.25a.75.75 0 01.75-.75h7a.75.75 0 010 1.5h-7a.75.75 0 01-.75-.75zm.75 2.25a.75.75 0 000 1.5h4a.75.75 0 000-1.5h-4z',
},
tip: {
viewBox: '0 0 18 18',
d: 'M14 0a8.8 8.8 0 0 0-6 2.6l-.5.4-.9 1H3.3a1.8 1.8 0 0 0-1.5.8L.1 7.6a.8.8 0 0 0 .4 1.1l3.1 1 .2.1 2.4 2.4.1.2 1 3a.8.8 0 0 0 1 .5l2.9-1.7a1.8 1.8 0 0 0 .8-1.5V9.5l1-1 .4-.4A8.8 8.8 0 0 0 16 2v-.1A1.8 1.8 0 0 0 14.2 0h-.1zm-3.5 10.6-.3.2L8 12.3l.5 1.8 2-1.2a.3.3 0 0 0 .1-.2v-2zM3.7 8.1l1.5-2.3.2-.3h-2a.3.3 0 0 0-.3.1l-1.2 2 1.8.5zm5.2-4.5a7.3 7.3 0 0 1 5.2-2.1h.1a.3.3 0 0 1 .3.3v.1a7.3 7.3 0 0 1-2.1 5.2l-.5.4a15.2 15.2 0 0 1-2.5 2L7.1 11 5 9l1.5-2.3a15.3 15.3 0 0 1 2-2.5l.4-.5zM12 5a1 1 0 1 1-2 0 1 1 0 0 1 2 0zm-8.4 9.6a1.5 1.5 0 1 0-2.2-2.2 7 7 0 0 0-1.1 3 .2.2 0 0 0 .3.3c.6 0 2.2-.4 3-1.1z',
},
caution: {
viewBox: '-1 1 18 18',
d: 'M8.9 1.5C8.7 1.2 8.4 1 8 1s-.7.2-.9.5l-7 12a1 1 0 0 0 0 1c.2.3.6.5 1 .5H15c.4 0 .7-.2.9-.5a1 1 0 0 0 0-1l-7-12zM9 13H7v-2h2v2zm0-3H7V6h2v4z',
},
danger: {
viewBox: '0 1 14 17',
d: 'M5 .3c.9 2.2.5 3.4-.5 4.3C3.5 5.6 2 6.5 1 8c-1.5 2-1.7 6.5 3.5 7.7-2.2-1.2-2.6-4.5-.3-6.6-.6 2 .6 3.3 2 2.8 1.4-.4 2.3.6 2.2 1.7 0 .8-.3 1.4-1 1.8A5.6 5.6 0 0 0 12 10c0-2.9-2.5-3.3-1.3-5.7-1.5.2-2 1.2-1.8 2.8 0 1-1 1.8-2 1.3-.6-.4-.6-1.2 0-1.8C8.2 5.3 8.7 2.5 5 .3z',
},
};
const { viewBox, d } = icons[type];
---
<aside class={`content ${type}`} aria-label={title}>
<p class="title" aria-hidden="true">
<span class="icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox={viewBox} width={16} height={16}>
<path fill-rule="evenodd" d={d}></path>
</svg>
</span>
{title}
</p>
<section>
<slot />
</section>
</aside>
<style>
aside {
--color-base-purple: 269, 79%;
--color-base-teal: 180, 80%;
--color-base-red: 351, 100%;
--color-base-yellow: 41, 100%;
--aside-color-base: var(--color-base-purple);
--aside-color-lightness: 54%;
--aside-accent-color: hsl(var(--aside-color-base), var(--aside-color-lightness));
--aside-text-lightness: 20%;
--aside-text-accent-color: hsl(var(--aside-color-base), var(--aside-text-lightness));
border-inline-start: 4px solid var(--aside-accent-color);
padding: 1rem;
background-color: hsla(var(--aside-color-base), var(--aside-color-lightness), 0.1);
/* Indicates the aside boundaries for forced colors users, transparent is changed to a solid color */
outline: 1px solid transparent;
}
.title {
line-height: 1;
margin-bottom: 0.5rem;
font-size: 0.9rem;
letter-spacing: 0.05em;
font-weight: bold;
text-transform: uppercase;
color: var(--aside-text-accent-color);
}
.icon svg {
width: 1.5em;
height: 1.5em;
vertical-align: middle;
fill: currentcolor;
}
aside :global(a),
aside :global(a > code:not([class*='language'])) {
color: var(--aside-text-accent-color);
}
aside :global(pre) {
margin-left: 0;
margin-right: 0;
}
.tip {
--aside-color-lightness: 42%;
--aside-color-base: var(--color-base-teal);
}
.caution {
--aside-color-lightness: 59%;
--aside-color-base: var(--color-base-yellow);
}
.danger {
--aside-color-lightness: 54%;
--aside-color-base: var(--color-base-red);
}
</style>

View file

@ -0,0 +1,32 @@
---
import Aside from './Aside.astro';
import type { CollectionEntry } from 'astro:content';
type Props = {
entry: CollectionEntry<'docs'>;
};
const { entry } = Astro.props;
const { Content } = await entry.render();
---
<Content
components={{
// Pass a mapping from the component name
// To an Astro or UI component import
// See your `astro.config.mjs` for
// for the Markdoc tag mapping
Aside,
}}
/>
<style is:global>
table {
margin-block: 2rem;
margin-inline: auto;
}
table td {
padding-block: 0.3rem;
padding-inline: 0.5rem;
}
</style>

View file

@ -0,0 +1,9 @@
import { defineCollection, z } from 'astro:content';
const docs = defineCollection({
schema: z.object({
title: z.string(),
}),
});
export const collections = { docs };

View file

@ -0,0 +1,39 @@
---
title: Welcome to Markdoc 👋
---
This simple starter showcases Markdoc with Content Collections. All Markdoc features are supported, including this nifty built-in `{% table %}` tag:
{% table %}
* Feature
* Supported
---
* `.mdoc` in Content Collections
* ✅
---
* Markdoc transform configuration
* ✅
---
* Astro components
* ✅
{% /table %}
{% aside title="Code Challenge" type="tip" %}
Reveal the secret message below by adding `revealSecret: true` to your list of Markdoc variables.
_Hint: Try [adding a `variables` object](https://markdoc.dev/docs/variables#global-variables) to your Markdoc config. Check the `astro.config.mjs`._
{% if $revealSecret %}
Maybe the real secret was the Rick Rolls we shared along the way.
![Rick Astley dancing](https://media.tenor.com/x8v1oNUOmg4AAAAM/rickroll-roll.gif)
{% /if %}
{% /aside %}
Check out [the `@astrojs/markdoc` integration][astro-markdoc] for complete documentation and usage examples.
[astro-markdoc]: https://docs.astro.build/en/guides/integrations-guide/markdoc/

2
examples/with-markdoc/src/env.d.ts vendored Normal file
View file

@ -0,0 +1,2 @@
/// <reference path="../.astro/types.d.ts" />
/// <reference types="astro/client" />

View file

@ -0,0 +1,35 @@
---
export interface Props {
title: string;
}
const { title } = Astro.props;
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width" />
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
<meta name="generator" content={Astro.generator} />
<title>{title}</title>
</head>
<body>
<slot />
</body>
</html>
<style is:global>
html {
font-family: system-ui, sans-serif;
background-color: #f6f6f6;
}
code {
font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono,
Bitstream Vera Sans Mono, Courier New, monospace;
}
main {
margin: auto;
max-width: 60ch;
}
</style>

View file

@ -0,0 +1,18 @@
---
import { getEntryBySlug } from 'astro:content';
import DocsContent from '../components/DocsContent.astro';
import Layout from '../layouts/Layout.astro';
const intro = await getEntryBySlug('docs', 'intro');
---
<Layout title={intro.data.title}>
<main>
<h1>{intro.data.title}</h1>
<!-- `DocsContent` is a thin wrapper around -->
<!-- the `Content` component provided by Content Collections, -->
<!-- with added configuration for components. -->
<!-- This allows you to share global components wherever you render your Markdoc. -->
<DocsContent entry={intro} />
</main>
</Layout>

View file

@ -0,0 +1,6 @@
{
"extends": "astro/tsconfigs/base",
"compilerOptions": {
"strictNullChecks": true
}
}

2
packages/astro/performance/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
.astro/
fixtures/**/src/content/generated/

View file

@ -0,0 +1,116 @@
/* eslint-disable no-console */
import { fileURLToPath } from 'url';
import { loadFixture } from '../test/test-utils.js';
import { generatePosts } from './scripts/generate-posts.mjs';
import yargs from 'yargs-parser';
import { cyan, bold, dim } from 'kleur/colors';
// Skip nonessential remark / rehype plugins for a fair comparison.
// This includes heading ID generation, syntax highlighting, GFM, and Smartypants.
process.env.ASTRO_PERFORMANCE_BENCHMARK = true;
const extByFixture = {
md: '.md',
mdx: '.mdx',
mdoc: '.mdoc',
};
const NUM_POSTS = 1000;
async function benchmark({ fixtures, templates }) {
for (const fixture of fixtures) {
const root = new URL(`./fixtures/${fixture}/`, import.meta.url);
await generatePosts({
postsDir: fileURLToPath(new URL('./src/content/generated/', root)),
numPosts: NUM_POSTS,
ext: extByFixture[fixture],
template: templates[fixture],
});
console.log(`[${fixture}] Generated posts`);
const { build } = await loadFixture({
root,
});
const now = performance.now();
console.log(`[${fixture}] Building...`);
await build();
console.log(cyan(`[${fixture}] Built in ${bold(getTimeStat(now, performance.now()))}.`));
}
}
// Test the build performance for content collections across multiple file types (md, mdx, mdoc)
(async function benchmarkAll() {
try {
const flags = yargs(process.argv.slice(2));
const test = Array.isArray(flags.test)
? flags.test
: typeof flags.test === 'string'
? [flags.test]
: ['simple', 'with-astro-components', 'with-react-components'];
const formats = Array.isArray(flags.format)
? flags.format
: typeof flags.format === 'string'
? [flags.format]
: ['md', 'mdx', 'mdoc'];
if (test.includes('simple')) {
const fixtures = formats;
console.log(
`\n${bold('Simple')} ${dim(`${NUM_POSTS} posts (${formatsToString(fixtures)})`)}`
);
await benchmark({
fixtures,
templates: {
md: 'simple.md',
mdx: 'simple.md',
mdoc: 'simple.md',
},
});
}
if (test.includes('with-astro-components')) {
const fixtures = formats.filter((format) => format !== 'md');
console.log(
`\n${bold('With Astro components')} ${dim(
`${NUM_POSTS} posts (${formatsToString(fixtures)})`
)}`
);
await benchmark({
fixtures,
templates: {
mdx: 'with-astro-components.mdx',
mdoc: 'with-astro-components.mdoc',
},
});
}
if (test.includes('with-react-components')) {
const fixtures = formats.filter((format) => format !== 'md');
console.log(
`\n${bold('With React components')} ${dim(
`${NUM_POSTS} posts (${formatsToString(fixtures)})`
)}`
);
await benchmark({
fixtures,
templates: {
mdx: 'with-react-components.mdx',
mdoc: 'with-react-components.mdoc',
},
});
}
} finally {
process.env.ASTRO_PERFORMANCE_BENCHMARK = false;
}
})();
function getTimeStat(timeStart, timeEnd) {
const buildTime = timeEnd - timeStart;
return buildTime < 750 ? `${Math.round(buildTime)}ms` : `${(buildTime / 1000).toFixed(2)}s`;
}
function formatsToString(formats) {
return formats.join(', ');
}

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,7 @@
import { defineConfig } from 'astro/config';
import react from "@astrojs/react";
// https://astro.build/config
export default defineConfig({
integrations: [react()]
});

View file

@ -0,0 +1,25 @@
{
"name": "@performance/md",
"version": "1.0.0",
"description": "",
"main": "index.js",
"private": true,
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview"
},
"keywords": [],
"author": "",
"license": "unlicensed",
"dependencies": {
"@astrojs/react": "^2.0.2",
"@performance/utils": "^0.0.0",
"@types/react": "^18.0.21",
"@types/react-dom": "^18.0.6",
"astro": "^2.0.12",
"react": "^18.0.0",
"react-dom": "^18.0.0"
}
}

View file

@ -0,0 +1,12 @@
---
import type { CollectionEntry } from 'astro:content';
type Props = {
entry: CollectionEntry<'generated'>;
}
const { entry } = Astro.props as Props;
const { Content } = await entry.render();
---
<Content />

View file

@ -0,0 +1,3 @@
/// <reference path="../../.astro/types.d.ts" />
/// <reference path="../.astro/types.d.ts" />
/// <reference types="astro/client" />

View file

@ -0,0 +1,12 @@
---
import { getCollection } from 'astro:content';
import { RenderContent } from '@performance/utils';
import ContentRenderer from '../ContentRenderer.astro';
const posts = await getCollection('generated');
---
<RenderContent
{posts}
renderer={ContentRenderer}
/>

View file

@ -0,0 +1,7 @@
{
"extends": "astro/tsconfigs/base",
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "react"
}
}

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,8 @@
import { defineConfig } from 'astro/config';
import markdoc from "@astrojs/markdoc";
import react from "@astrojs/react";
// https://astro.build/config
export default defineConfig({
integrations: [markdoc(), react()],
});

View file

@ -0,0 +1,26 @@
{
"name": "@performance/mdoc",
"version": "1.0.0",
"description": "",
"main": "index.js",
"private": true,
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview"
},
"keywords": [],
"author": "",
"license": "unlicensed",
"dependencies": {
"@astrojs/markdoc": "^0.0.0",
"@astrojs/react": "^2.0.2",
"@performance/utils": "^0.0.0",
"@types/react": "^18.0.21",
"@types/react-dom": "^18.0.6",
"astro": "^2.0.12",
"react": "^18.0.0",
"react-dom": "^18.0.0"
}
}

View file

@ -0,0 +1,43 @@
---
import { Title, Aside, LikeButton, HydratedLikeButton } from '@performance/utils';
import type { CollectionEntry } from 'astro:content';
type Props = {
entry: CollectionEntry<'generated'>;
}
const { entry } = Astro.props as Props;
const { Content } = await entry.render();
---
{entry.data.type === 'with-astro-components'
? <Content config={{
tags: {
aside: {
render: 'Aside',
attributes: {
type: { type: String },
title: { type: String },
},
}
}
}} components={{ h1: Title, Aside }} />
: entry.data.type === 'with-react-components'
? <Content config={{
tags: {
'like-button': {
render: 'LikeButton',
attributes: {
liked: { type: Boolean },
},
},
'hydrated-like-button': {
render: 'HydratedLikeButton',
attributes: {
liked: { type: Boolean },
},
},
}
}} components={{ LikeButton, HydratedLikeButton }} />
: <Content />
}

View file

@ -0,0 +1,2 @@
/// <reference path="../.astro/types.d.ts" />
/// <reference types="astro/client" />

View file

@ -0,0 +1,12 @@
---
import { getCollection } from 'astro:content';
import { RenderContent } from '@performance/utils';
import ContentRenderer from '../ContentRenderer.astro';
const posts = await getCollection('generated');
---
<RenderContent
{posts}
renderer={ContentRenderer}
/>

View file

@ -0,0 +1,7 @@
{
"extends": "astro/tsconfigs/base",
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "react"
}
}

View file

@ -0,0 +1,8 @@
import { defineConfig } from 'astro/config';
import mdx from "@astrojs/mdx";
import react from "@astrojs/react";
// https://astro.build/config
export default defineConfig({
integrations: [mdx(), react()]
});

View file

@ -0,0 +1,26 @@
{
"name": "@performance/mdx",
"version": "1.0.0",
"description": "",
"main": "index.js",
"private": true,
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview"
},
"keywords": [],
"author": "",
"license": "unlicensed",
"dependencies": {
"@astrojs/mdx": "^0.17.2",
"@astrojs/react": "^2.0.2",
"@performance/utils": "^0.0.0",
"@types/react": "^18.0.21",
"@types/react-dom": "^18.0.6",
"astro": "^2.0.12",
"react": "^18.0.0",
"react-dom": "^18.0.0"
}
}

View file

@ -0,0 +1,16 @@
---
import { Title } from '@performance/utils';
import type { CollectionEntry } from 'astro:content';
type Props = {
entry: CollectionEntry<'generated'>;
}
const { entry } = Astro.props as Props;
const { Content } = await entry.render();
---
{entry.data.type === 'with-astro-components'
? <Content components={{ h1: Title }} />
: <Content />
}

View file

@ -0,0 +1,2 @@
/// <reference path="../.astro/types.d.ts" />
/// <reference types="astro/client" />

View file

@ -0,0 +1,12 @@
---
import { getCollection } from 'astro:content';
import { RenderContent } from '@performance/utils';
import ContentRenderer from '../ContentRenderer.astro';
const posts = await getCollection('generated');
---
<RenderContent
{posts}
renderer={ContentRenderer}
/>

View file

@ -0,0 +1,7 @@
{
"extends": "astro/tsconfigs/base",
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "react"
}
}

View file

@ -0,0 +1,116 @@
---
// Inspired by the `Aside` component from docs.astro.build
// https://github.com/withastro/docs/blob/main/src/components/Aside.astro
export interface Props {
type?: 'note' | 'tip' | 'caution' | 'danger';
title?: string;
}
const labelByType = {
note: 'Note',
tip: 'Tip',
caution: 'Caution',
danger: 'Danger',
};
const { type = 'note' } = Astro.props as Props;
const title = Astro.props.title ?? labelByType[type] ?? '';
// SVG icon paths based on GitHub Octicons
const icons: Record<NonNullable<Props['type']>, { viewBox: string; d: string }> = {
note: {
viewBox: '0 0 18 18',
d: 'M0 3.75C0 2.784.784 2 1.75 2h12.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0114.25 14H1.75A1.75 1.75 0 010 12.25v-8.5zm1.75-.25a.25.25 0 00-.25.25v8.5c0 .138.112.25.25.25h12.5a.25.25 0 00.25-.25v-8.5a.25.25 0 00-.25-.25H1.75zM3.5 6.25a.75.75 0 01.75-.75h7a.75.75 0 010 1.5h-7a.75.75 0 01-.75-.75zm.75 2.25a.75.75 0 000 1.5h4a.75.75 0 000-1.5h-4z',
},
tip: {
viewBox: '0 0 18 18',
d: 'M14 0a8.8 8.8 0 0 0-6 2.6l-.5.4-.9 1H3.3a1.8 1.8 0 0 0-1.5.8L.1 7.6a.8.8 0 0 0 .4 1.1l3.1 1 .2.1 2.4 2.4.1.2 1 3a.8.8 0 0 0 1 .5l2.9-1.7a1.8 1.8 0 0 0 .8-1.5V9.5l1-1 .4-.4A8.8 8.8 0 0 0 16 2v-.1A1.8 1.8 0 0 0 14.2 0h-.1zm-3.5 10.6-.3.2L8 12.3l.5 1.8 2-1.2a.3.3 0 0 0 .1-.2v-2zM3.7 8.1l1.5-2.3.2-.3h-2a.3.3 0 0 0-.3.1l-1.2 2 1.8.5zm5.2-4.5a7.3 7.3 0 0 1 5.2-2.1h.1a.3.3 0 0 1 .3.3v.1a7.3 7.3 0 0 1-2.1 5.2l-.5.4a15.2 15.2 0 0 1-2.5 2L7.1 11 5 9l1.5-2.3a15.3 15.3 0 0 1 2-2.5l.4-.5zM12 5a1 1 0 1 1-2 0 1 1 0 0 1 2 0zm-8.4 9.6a1.5 1.5 0 1 0-2.2-2.2 7 7 0 0 0-1.1 3 .2.2 0 0 0 .3.3c.6 0 2.2-.4 3-1.1z',
},
caution: {
viewBox: '-1 1 18 18',
d: 'M8.9 1.5C8.7 1.2 8.4 1 8 1s-.7.2-.9.5l-7 12a1 1 0 0 0 0 1c.2.3.6.5 1 .5H15c.4 0 .7-.2.9-.5a1 1 0 0 0 0-1l-7-12zM9 13H7v-2h2v2zm0-3H7V6h2v4z',
},
danger: {
viewBox: '0 1 14 17',
d: 'M5 .3c.9 2.2.5 3.4-.5 4.3C3.5 5.6 2 6.5 1 8c-1.5 2-1.7 6.5 3.5 7.7-2.2-1.2-2.6-4.5-.3-6.6-.6 2 .6 3.3 2 2.8 1.4-.4 2.3.6 2.2 1.7 0 .8-.3 1.4-1 1.8A5.6 5.6 0 0 0 12 10c0-2.9-2.5-3.3-1.3-5.7-1.5.2-2 1.2-1.8 2.8 0 1-1 1.8-2 1.3-.6-.4-.6-1.2 0-1.8C8.2 5.3 8.7 2.5 5 .3z',
},
};
const { viewBox, d } = icons[type];
---
<aside class={`content ${type}`} aria-label={title}>
<p class="title" aria-hidden="true">
<span class="icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox={viewBox} width={16} height={16}>
<path fill-rule="evenodd" d={d}></path>
</svg>
</span>
{title}
</p>
<section>
<slot />
</section>
</aside>
<style>
aside {
--color-base-purple: 269, 79%;
--color-base-teal: 180, 80%;
--color-base-red: 351, 100%;
--color-base-yellow: 41, 100%;
--aside-color-base: var(--color-base-purple);
--aside-color-lightness: 54%;
--aside-accent-color: hsl(var(--aside-color-base), var(--aside-color-lightness));
--aside-text-lightness: 20%;
--aside-text-accent-color: hsl(var(--aside-color-base), var(--aside-text-lightness));
border-inline-start: 4px solid var(--aside-accent-color);
padding: 1rem;
background-color: hsla(var(--aside-color-base), var(--aside-color-lightness), 0.1);
/* Indicates the aside boundaries for forced colors users, transparent is changed to a solid color */
outline: 1px solid transparent;
}
.title {
line-height: 1;
margin-bottom: 0.5rem;
font-size: 0.9rem;
letter-spacing: 0.05em;
font-weight: bold;
text-transform: uppercase;
color: var(--aside-text-accent-color);
}
.icon svg {
width: 1.5em;
height: 1.5em;
vertical-align: middle;
fill: currentcolor;
}
aside :global(a),
aside :global(a > code:not([class*='language'])) {
color: var(--aside-text-accent-color);
}
aside :global(pre) {
margin-left: 0;
margin-right: 0;
}
.tip {
--aside-color-lightness: 42%;
--aside-color-base: var(--color-base-teal);
}
.caution {
--aside-color-lightness: 59%;
--aside-color-base: var(--color-base-yellow);
}
.danger {
--aside-color-lightness: 54%;
--aside-color-base: var(--color-base-red);
}
</style>

View file

@ -0,0 +1,12 @@
---
import LikeButton from "./LikeButton";
type Props = {
liked: boolean;
}
---
<!-- Markdoc doesn't support `client:` directives -->
<!-- Use this Astro wrapper as a stand-in -->
<LikeButton client:load liked={Astro.props.liked} />

View file

@ -0,0 +1,11 @@
/** @jsxImportSource react */
import { useState } from 'react';
export default function LikeButton({ liked: likedInitial }: {liked: boolean}) {
const [liked, setLiked] = useState(likedInitial);
return (
<button onClick={() => setLiked(!liked)}>
{!liked ? <span>Like </span> : <span>Unlike 💔</span>}
</button>
)
}

View file

@ -0,0 +1,31 @@
---
type Props = {
posts: any[];
renderer: any;
}
const { posts, renderer: ContentRenderer } = Astro.props;
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Md render test</title>
</head>
<body>
{
posts.map((entry) => {
return (
<div>
<h1>{entry.data.title}</h1>
<p>{entry.data.description}</p>
<ContentRenderer {entry} />
</div>
);
})
}
</body>
</html>

View file

@ -0,0 +1,8 @@
<h1><slot /></h1>
<style>
h1 {
color: red;
text-transform: uppercase;
}
</style>

View file

@ -0,0 +1,6 @@
// @ts-nocheck
export { default as RenderContent } from './RenderContent.astro';
export { default as Aside } from './Aside.astro';
export { default as Title } from './Title.astro';
export { default as LikeButton } from './LikeButton';
export { default as HydratedLikeButton } from './HydratedLikeButton.astro';

View file

@ -0,0 +1,19 @@
{
"name": "@performance/utils",
"version": "0.0.0",
"description": "",
"main": "index.js",
"type": "module",
"private": true,
"keywords": [],
"author": "",
"license": "unlicensed",
"devDependencies": {
"astro": "^2.0.12",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"exports": {
".": "./index.ts"
}
}

View file

@ -0,0 +1,6 @@
{
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "react"
}
}

View file

@ -0,0 +1,19 @@
{
"name": "@test/performance",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"benchmark": "node ./content-benchmark.mjs"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/yargs-parser": "^21.0.0",
"cross-env": "^7.0.3",
"kleur": "^4.1.5",
"npm-run-all": "^4.1.5",
"yargs-parser": "^21.0.1"
}
}

View file

@ -0,0 +1,18 @@
/* eslint-disable no-console */
import { generatePosts } from './generate-posts.mjs';
(async () => {
const postsDir = process.argv[2];
const numPosts =
typeof process.argv[3] === 'string' && process.argv[3].length > 0
? Number(process.argv[3])
: undefined;
const ext = process.argv[4];
const template = process.argv[5];
await generatePosts({ postsDir, numPosts, ext, template });
console.log(`${numPosts} ${ext} posts written to ${JSON.stringify(postsDir)} 🚀`);
})();

View file

@ -0,0 +1,30 @@
import fs from 'fs';
import path from 'path';
const NUM_POSTS = 10;
const POSTS_DIR = './src/content/posts.generated';
const EXT = '.md';
const TEMPLATE = 'simple.md';
export async function generatePosts({
postsDir = POSTS_DIR,
numPosts = NUM_POSTS,
ext = EXT,
template = TEMPLATE,
}) {
if (fs.existsSync(postsDir)) {
const files = await fs.promises.readdir(postsDir);
await Promise.all(files.map((file) => fs.promises.unlink(path.join(postsDir, file))));
} else {
await fs.promises.mkdir(postsDir, { recursive: true });
}
await Promise.all(
Array.from(Array(numPosts).keys()).map((idx) => {
return fs.promises.writeFile(
`${postsDir}/post-${idx}${ext.startsWith('.') ? ext : `.${ext}`}`,
fs.readFileSync(new URL(`./templates/${template}`, import.meta.url), 'utf8')
);
})
);
}

View file

@ -0,0 +1,43 @@
---
title: Simple
---
# Simple post
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur interdum quam vitae est dapibus auctor. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Vivamus id purus vel ante interdum eleifend non sed magna. Nullam aliquet metus eget nunc pretium, ac malesuada elit ultricies. Quisque fermentum tellus sed risus tristique tincidunt. Interdum et malesuada fames ac ante ipsum primis in faucibus. Maecenas eleifend odio sed tortor rhoncus venenatis. Maecenas dignissim convallis sem et sagittis. Aliquam facilisis auctor consectetur. Morbi vulputate fermentum lobortis. Aenean luctus risus erat, sit amet imperdiet lectus tempor et.
Aliquam erat volutpat. Vivamus sodales auctor hendrerit. Proin sollicitudin, neque id volutpat ultrices, urna tellus maximus quam, at placerat diam quam a nisl. In commodo, nibh quis rhoncus lacinia, felis nisi egestas tortor, dictum mollis magna massa at tortor. Cras tempus eleifend turpis, nec suscipit velit egestas a. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse nec nulla accumsan, sollicitudin dolor non, varius ipsum. Sed vel congue felis, sit amet bibendum neque. Pellentesque ut diam mollis augue auctor venenatis. Sed vitae aliquet lacus. Proin rutrum eget urna in vehicula. Vestibulum malesuada quis velit ac imperdiet. Donec interdum posuere nisl in auctor. Integer auctor pretium posuere.
Aenean tincidunt vitae augue id lacinia. Fusce a lorem accumsan, luctus magna non, fermentum arcu. Quisque mattis nibh ut ultrices vehicula. Fusce at porta mauris, eu sollicitudin augue. Curabitur tempor ante vulputate posuere interdum. Nam volutpat odio in blandit dapibus. Aliquam sit amet rutrum tortor.
Nulla eu odio nisl. Quisque malesuada arcu quis velit fermentum condimentum. Suspendisse potenti. Nullam non egestas sem. Sed et mi pharetra, ornare nunc ultricies, cursus est. Cras dignissim nisl eleifend nisl condimentum placerat. Vivamus tristique mattis vestibulum.
Maecenas at convallis dui. Pellentesque ac convallis libero. Mauris elementum arcu in quam pulvinar, a tincidunt dolor volutpat. Donec posuere eros ac nunc aliquam, non iaculis purus faucibus. Maecenas non lacus eu elit hendrerit fringilla eget vitae justo. Donec non lorem eu libero placerat volutpat. Vivamus euismod tristique lacus quis tincidunt.
Morbi a ligula eu odio dictum pharetra. Vestibulum a leo sit amet urna sodales facilisis posuere pretium lorem. Duis consectetur elementum sodales. Ut id libero quis dui laoreet faucibus eget ac felis. Suspendisse eu augue facilisis, consequat ex at, malesuada justo. Fusce tempor convallis orci a tristique. Pellentesque dapibus magna in sapien congue pharetra. Suspendisse potenti. Fusce in tortor justo. In hac habitasse platea dictumst. Pellentesque ligula odio, auctor vel consectetur quis, egestas a lectus. Sed arcu sapien, venenatis vitae nunc vitae, feugiat consequat elit.
Fusce bibendum odio tellus, ac consequat magna fringilla nec. Donec sed purus at magna pulvinar iaculis ac at nulla. Cras placerat, velit quis suscipit malesuada, eros dui ultrices sapien, sodales imperdiet enim ipsum vitae nisi. Mauris malesuada pretium nibh et luctus. Suspendisse potenti. In ante nibh, euismod at diam in, dapibus facilisis nunc. Suspendisse eleifend mollis dolor sit amet tristique. Nulla mattis tempor urna, nec pellentesque ante feugiat ut. Curabitur eleifend purus sed justo facilisis lacinia. Etiam maximus magna rhoncus quam tincidunt sollicitudin. Proin rhoncus metus lacus, non euismod mi gravida ac. Nam ac ipsum nec ante ultrices tempus ac mollis erat. Quisque ac tortor dolor. Integer eros mi, porttitor at rutrum ut, cursus sit amet ex. Pellentesque sed tortor vitae lorem malesuada gravida. Pellentesque bibendum ex nunc, non cursus lorem viverra gravida.
Integer lobortis erat quis dolor maximus porta. Sed ipsum est, maximus sit amet hendrerit ac, euismod quis nisi. Sed tincidunt, nisi sit amet varius tempus, turpis nisi sodales ante, sed ultricies urna neque vel purus. Maecenas sed laoreet tortor. Pellentesque enim massa, cursus in mauris vitae, facilisis egestas nisi. Mauris non ultrices purus, nec cursus diam. Proin eget ullamcorper augue. Pellentesque vehicula, sem vel dapibus tempus, neque tortor euismod libero, sed euismod diam enim id sapien. Sed mauris tellus, pretium eu ornare vitae, rhoncus at quam. Donec luctus mollis justo id rutrum. Aenean efficitur arcu nisi, non dignissim massa auctor et. In egestas lobortis nisi ac pharetra. Nam ultricies ipsum ut dui porta, sed commodo arcu vestibulum. Sed in felis molestie ante sodales auctor.
Praesent ac augue dui. Sed venenatis sit amet quam non rutrum. Vestibulum vitae tempor mi. Cras id luctus sapien, consectetur euismod magna. Nunc quis pellentesque sem, ut suscipit justo. Aliquam dignissim risus ante, vitae luctus enim vestibulum id. In hac habitasse platea dictumst. Nam rhoncus ante sed commodo porta. Ut lectus eros, porta sit amet velit vitae, elementum dignissim nulla. Cras nec scelerisque nulla. Quisque in diam eleifend, congue nulla eu, vestibulum magna. Sed vel purus elementum, mattis nunc id, mollis arcu. Pellentesque in pellentesque ipsum, non condimentum augue. Aenean tincidunt dui ut purus aliquet pretium. Integer vitae velit aliquet, tincidunt urna sed, bibendum lorem. Vivamus sit amet sapien ut sapien rhoncus fringilla vel a mi.
Praesent dignissim, arcu vel sollicitudin dictum, augue velit pretium ante, sit amet egestas velit lectus et tortor. In egestas ullamcorper risus, non vestibulum diam ultricies eu. Praesent a ex ac nisi consequat rhoncus. Fusce feugiat feugiat libero, vel lobortis mauris faucibus elementum. Mauris vitae luctus sapien. Etiam id pretium metus, in lacinia eros. Morbi et dictum risus. Morbi fringilla lorem ut elit fringilla blandit.
Nullam eu nibh ipsum. Curabitur aliquet varius ante, a pretium mauris dictum in. Integer nibh arcu, tristique ac sagittis nec, maximus et ligula. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin blandit nec mi vel hendrerit. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Morbi consequat blandit orci, sed placerat sem fermentum sit amet. Quisque eu iaculis nisl. Suspendisse quam mauris, semper vel eleifend vitae, mollis in arcu.
Aenean porttitor blandit orci id bibendum. Nunc sit amet ligula bibendum, congue urna fringilla, dictum purus. Pellentesque blandit, nibh id laoreet placerat, mauris dui semper mi, id tincidunt metus massa nec nisi. Suspendisse potenti. Phasellus ut risus velit. Curabitur porttitor metus nunc, in malesuada justo gravida sit amet. Cras auctor justo magna, ut eleifend turpis dictum id. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Pellentesque ut augue ac velit imperdiet suscipit non at massa.
Suspendisse euismod ornare quam id varius. Etiam ac velit id quam accumsan imperdiet sit amet eu nibh. Ut nec massa ultricies enim iaculis feugiat. Phasellus vehicula massa id ligula dapibus, sit amet viverra justo volutpat. Sed nunc est, efficitur et purus id, lacinia pellentesque metus. Pellentesque mi quam, maximus a blandit nec, mollis eget leo. Nulla sit amet elementum augue. Aenean id luctus nisl. Etiam non ante id augue dignissim suscipit in id quam. Quisque non consequat diam, eget condimentum turpis. Donec fringilla metus eget condimentum congue. Pellentesque aliquet blandit posuere. In bibendum ultrices ex a ornare. Donec quis efficitur metus. In commodo sollicitudin turpis et efficitur. Ut ac viverra nunc, sit amet varius sapien.
In sit amet felis et diam vehicula placerat. Nullam finibus lorem libero, et pretium eros consectetur euismod. In fringilla semper diam et hendrerit. Phasellus id erat at justo imperdiet aliquet. Donec dignissim auctor nunc, et ultrices ex rutrum nec. Aliquam ut cursus leo. Suspendisse semper velit ac lorem aliquet fermentum. Suspendisse congue mi et ultrices bibendum. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Donec ac neque et enim facilisis posuere volutpat a augue. Vivamus feugiat fermentum rhoncus.
Proin ultricies turpis non mauris finibus elementum. Cras scelerisque pretium justo non efficitur. Curabitur at risus ut velit ullamcorper fringilla congue in nulla. Nunc laoreet lacinia purus at lobortis. Sed vulputate ex non cursus accumsan. Morbi risus elit, porttitor ac hendrerit sed, commodo suscipit nisi. Vivamus vestibulum ex sapien, sagittis blandit velit fermentum et.
Suspendisse ut ullamcorper ex, a hendrerit elit. Vivamus gravida tempor efficitur. Ut lobortis neque a mollis efficitur. Donec sit amet arcu quis massa fringilla consequat. Duis vitae nisl laoreet, suscipit tellus nec, malesuada sem. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus in sollicitudin nisi. Fusce id sapien ac nunc sagittis lobortis tempor auctor eros. Nunc lacinia enim vitae massa lacinia, suscipit facilisis turpis tempus. Integer nec mollis ex. Pellentesque magna nisl, dignissim in mi quis, malesuada elementum nibh. Duis consectetur erat quis interdum ornare. Phasellus lorem felis, aliquam a nunc at, luctus faucibus odio. In hac habitasse platea dictumst.
Vestibulum sit amet lorem arcu. Integer sed nisl ut turpis dapibus mollis sit amet sed turpis. Donec massa dolor, blandit at lacinia eu, ultricies eu turpis. Sed mollis non diam non consectetur. Morbi suscipit metus at orci sagittis ultricies. Mauris pulvinar maximus ex vitae convallis. Ut imperdiet vehicula mi ut imperdiet. Aliquam et dui at turpis volutpat condimentum. Morbi laoreet scelerisque leo, non tristique ante convallis vulputate. Nam et lorem enim. Cras cursus sodales nisi, nec facilisis felis feugiat sit amet. Aenean consequat pellentesque magna id venenatis. Nunc sed quam consequat, vestibulum diam nec, dignissim justo. Duis vulputate nibh sit amet tortor lobortis iaculis. Curabitur pellentesque dui sapien, nec varius libero hendrerit vel.
Curabitur quis mi ac massa hendrerit ornare id eget velit. Nulla dui lacus, hendrerit et fringilla sed, eleifend ut erat. Nunc ut fringilla ex, sit amet fringilla libero. Maecenas non ullamcorper orci. Duis posuere erat et urna rhoncus iaculis. Proin pellentesque porttitor nulla, non blandit ante semper vitae. Phasellus ut augue venenatis, tempus purus eu, efficitur massa. Etiam vel egestas tellus, ac pharetra lectus. Aliquam non commodo turpis. Quisque pharetra nunc et mauris bibendum, id vestibulum tellus fringilla. Nullam enim massa, porta id nisi at, accumsan sollicitudin elit. Morbi auctor lectus vitae orci cursus, et hendrerit odio accumsan. Pellentesque quis libero auctor, tempor dolor tempor, finibus arcu. Aliquam non cursus ex. Aliquam quis lacus ut purus pellentesque ultrices in a augue.
Morbi nunc diam, egestas sed condimentum a, interdum suscipit ligula. Morbi interdum dignissim imperdiet. Interdum et malesuada fames ac ante ipsum primis in faucibus. Mauris egestas, nulla nec feugiat porttitor, ex magna sodales nisl, ac volutpat tortor mauris vitae nibh. Cras cursus dignissim pretium. Nunc faucibus dui at lectus pellentesque vehicula. Maecenas tincidunt, libero quis hendrerit aliquet, tortor leo iaculis enim, sit amet ullamcorper tellus risus a orci. Donec dignissim metus in nulla eleifend molestie. Nunc at turpis et sem laoreet rutrum. Nulla facilisi. Sed luctus nisi sed egestas cursus.

View file

@ -0,0 +1,19 @@
---
type: with-astro-components
title: Post with Astro components
---
# This should be rendered with a title component
{% aside type="tip" %}
This is a tip component
{% /aside %}
{% aside type="note" %}
This is a note component
{% /aside %}
{% aside type="caution" %}
This is a caution component
{% /aside %}
{% aside type="danger" %}
This is a danger component
{% /aside %}

View file

@ -0,0 +1,13 @@
---
type: with-astro-components
title: Post with Astro components
---
import { Aside } from '@performance/utils';
# This should be rendered with a title component
<Aside type="tip">This is a tip component</Aside>
<Aside type="note">This is a note component</Aside>
<Aside type="caution">This is a caution component</Aside>
<Aside type="danger">This is a danger component</Aside>

View file

@ -0,0 +1,12 @@
---
type: with-react-components
title: Post with React components
---
# This render clickable like components
{% like-button liked=true /%}
{% like-button liked=false /%}
{% hydrated-like-button liked=true /%}
{% hydrated-like-button liked=false /%}

View file

@ -0,0 +1,14 @@
---
type: with-react-components
title: Post with React components
---
import { LikeButton, HydratedLikeButton } from '@performance/utils';
# This render clickable like components
<LikeButton liked={true} />
<LikeButton liked={false} />
<HydratedLikeButton liked={true} />
<HydratedLikeButton liked={false} />

View file

@ -978,12 +978,28 @@ export interface AstroConfig extends z.output<typeof AstroConfigSchema> {
integrations: AstroIntegration[];
}
export interface ContentEntryType {
extensions: string[];
getEntryInfo(params: { fileUrl: URL; contents: string }): Promise<{
data: Record<string, unknown>;
/**
* Used for error hints to point to correct line and location
* Should be the untouched data as read from the file,
* including newlines
*/
rawData: string;
body: string;
slug: string;
}>;
contentModuleTypes?: string;
}
export interface AstroSettings {
config: AstroConfig;
adapter: AstroAdapter | undefined;
injectedRoutes: InjectedRoute[];
pageExtensions: string[];
contentEntryTypes: ContentEntryType[];
renderers: AstroRenderer[];
scripts: {
stage: InjectedScriptStage;

View file

@ -1,4 +1,3 @@
export const contentFileExts = ['.md', '.mdx'];
export const PROPAGATED_ASSET_FLAG = 'astroPropagatedAssets';
export const CONTENT_FLAG = 'astroContent';
export const VIRTUAL_MODULE_ID = 'astro:content';

View file

@ -184,7 +184,7 @@ async function render({
return {
Content,
headings: mod.getHeadings(),
remarkPluginFrontmatter: mod.frontmatter,
headings: mod.getHeadings?.() ?? [],
remarkPluginFrontmatter: mod.frontmatter ?? {},
};
}

View file

@ -1,7 +1,17 @@
declare module 'astro:content' {
interface Render {
'.md': Promise<{
Content: import('astro').MarkdownInstance<{}>['Content'];
headings: import('astro').MarkdownHeading[];
remarkPluginFrontmatter: Record<string, any>;
}>;
}
}
declare module 'astro:content' {
export { z } from 'astro/zod';
export type CollectionEntry<C extends keyof typeof entryMap> =
(typeof entryMap)[C][keyof (typeof entryMap)[C]] & Render;
(typeof entryMap)[C][keyof (typeof entryMap)[C]];
type BaseSchemaWithoutEffects =
| import('astro/zod').AnyZodObject
@ -57,14 +67,6 @@ declare module 'astro:content' {
Required<ContentConfig['collections'][C]>['schema']
>;
type Render = {
render(): Promise<{
Content: import('astro').MarkdownInstance<{}>['Content'];
headings: import('astro').MarkdownHeading[];
remarkPluginFrontmatter: Record<string, any>;
}>;
};
const entryMap: {
// @@ENTRY_MAP@@
};

View file

@ -4,7 +4,7 @@ import type fsMod from 'node:fs';
import * as path from 'node:path';
import { fileURLToPath, pathToFileURL } from 'node:url';
import { normalizePath, ViteDevServer } from 'vite';
import type { AstroSettings } from '../@types/astro.js';
import type { AstroSettings, ContentEntryType } from '../@types/astro.js';
import { AstroError, AstroErrorData } from '../core/errors/index.js';
import { info, LogOptions, warn } from '../core/logger/core.js';
import { isRelativePath } from '../core/path.js';
@ -14,6 +14,7 @@ import {
ContentObservable,
ContentPaths,
EntryInfo,
getContentEntryExts,
getContentPaths,
getEntryInfo,
getEntrySlug,
@ -57,11 +58,12 @@ export async function createContentTypesGenerator({
}: CreateContentGeneratorParams) {
const contentTypes: ContentTypes = {};
const contentPaths = getContentPaths(settings.config, fs);
const contentEntryExts = getContentEntryExts(settings);
let events: EventWithOptions[] = [];
let debounceTimeout: NodeJS.Timeout | undefined;
const contentTypesBase = await fs.promises.readFile(contentPaths.typesTemplate, 'utf-8');
const typeTemplateContent = await fs.promises.readFile(contentPaths.typesTemplate, 'utf-8');
async function init(): Promise<
{ typesGenerated: true } | { typesGenerated: false; reason: 'no-content-dir' }
@ -121,7 +123,7 @@ export async function createContentTypesGenerator({
}
return { shouldGenerateTypes: true };
}
const fileType = getEntryType(fileURLToPath(event.entry), contentPaths);
const fileType = getEntryType(fileURLToPath(event.entry), contentPaths, contentEntryExts);
if (fileType === 'ignored') {
return { shouldGenerateTypes: false };
}
@ -261,8 +263,9 @@ export async function createContentTypesGenerator({
fs,
contentTypes,
contentPaths,
contentTypesBase,
typeTemplateContent,
contentConfig: observable.status === 'loaded' ? observable.config : undefined,
contentEntryTypes: settings.contentEntryTypes,
});
if (observable.status === 'loaded' && ['info', 'warn'].includes(logLevel)) {
warnNonexistentCollections({
@ -300,7 +303,7 @@ async function parseSlug({
// on dev server startup or production build init.
const rawContents = await fs.promises.readFile(event.entry, 'utf-8');
const { data: frontmatter } = parseFrontmatter(rawContents, fileURLToPath(event.entry));
return getEntrySlug({ ...entryInfo, data: frontmatter });
return getEntrySlug({ ...entryInfo, unvalidatedSlug: frontmatter.slug });
}
function setEntry(
@ -320,13 +323,15 @@ async function writeContentFiles({
fs,
contentPaths,
contentTypes,
contentTypesBase,
typeTemplateContent,
contentEntryTypes,
contentConfig,
}: {
fs: typeof fsMod;
contentPaths: ContentPaths;
contentTypes: ContentTypes;
contentTypesBase: string;
typeTemplateContent: string;
contentEntryTypes: ContentEntryType[];
contentConfig?: ContentConfig;
}) {
let contentTypesStr = '';
@ -338,8 +343,11 @@ async function writeContentFiles({
for (const entryKey of entryKeys) {
const entryMetadata = contentTypes[collectionKey][entryKey];
const dataType = collectionConfig?.schema ? `InferEntrySchema<${collectionKey}>` : 'any';
const renderType = `{ render(): Render[${JSON.stringify(
path.extname(JSON.parse(entryKey))
)}] }`;
const slugType = JSON.stringify(entryMetadata.slug);
contentTypesStr += `${entryKey}: {\n id: ${entryKey},\n slug: ${slugType},\n body: string,\n collection: ${collectionKey},\n data: ${dataType}\n},\n`;
contentTypesStr += `${entryKey}: {\n id: ${entryKey},\n slug: ${slugType},\n body: string,\n collection: ${collectionKey},\n data: ${dataType}\n} & ${renderType},\n`;
}
contentTypesStr += `},\n`;
}
@ -359,13 +367,21 @@ async function writeContentFiles({
configPathRelativeToCacheDir = configPathRelativeToCacheDir.replace(/\.ts$/, '');
}
contentTypesBase = contentTypesBase.replace('// @@ENTRY_MAP@@', contentTypesStr);
contentTypesBase = contentTypesBase.replace(
for (const contentEntryType of contentEntryTypes) {
if (contentEntryType.contentModuleTypes) {
typeTemplateContent = contentEntryType.contentModuleTypes + '\n' + typeTemplateContent;
}
}
typeTemplateContent = typeTemplateContent.replace('// @@ENTRY_MAP@@', contentTypesStr);
typeTemplateContent = typeTemplateContent.replace(
"'@@CONTENT_CONFIG_TYPE@@'",
contentConfig ? `typeof import(${JSON.stringify(configPathRelativeToCacheDir)})` : 'never'
);
await fs.promises.writeFile(new URL(CONTENT_TYPES_FILE, contentPaths.cacheDir), contentTypesBase);
await fs.promises.writeFile(
new URL(CONTENT_TYPES_FILE, contentPaths.cacheDir),
typeTemplateContent
);
}
function warnNonexistentCollections({

View file

@ -7,7 +7,7 @@ import { ErrorPayload as ViteErrorPayload, normalizePath, ViteDevServer } from '
import { z } from 'zod';
import { AstroConfig, AstroSettings } from '../@types/astro.js';
import { AstroError, AstroErrorData } from '../core/errors/index.js';
import { contentFileExts, CONTENT_TYPES_FILE } from './consts.js';
import { CONTENT_TYPES_FILE } from './consts.js';
export const collectionConfigParser = z.object({
schema: z.any().optional(),
@ -29,14 +29,7 @@ export const contentConfigParser = z.object({
export type CollectionConfig = z.infer<typeof collectionConfigParser>;
export type ContentConfig = z.infer<typeof contentConfigParser>;
type Entry = {
id: string;
collection: string;
slug: string;
data: any;
body: string;
_internal: { rawData: string; filePath: string };
};
type EntryInternal = { rawData: string; filePath: string };
export type EntryInfo = {
id: string;
@ -53,10 +46,10 @@ export function getEntrySlug({
id,
collection,
slug,
data: unparsedData,
}: Pick<Entry, 'id' | 'collection' | 'slug' | 'data'>) {
unvalidatedSlug,
}: EntryInfo & { unvalidatedSlug?: unknown }) {
try {
return z.string().default(slug).parse(unparsedData.slug);
return z.string().default(slug).parse(unvalidatedSlug);
} catch {
throw new AstroError({
...AstroErrorData.InvalidContentEntrySlugError,
@ -65,9 +58,12 @@ export function getEntrySlug({
}
}
export async function getEntryData(entry: Entry, collectionConfig: CollectionConfig) {
export async function getEntryData(
entry: EntryInfo & { unvalidatedData: Record<string, unknown>; _internal: EntryInternal },
collectionConfig: CollectionConfig
) {
// Remove reserved `slug` field before parsing data
let { slug, ...data } = entry.data;
let { slug, ...data } = entry.unvalidatedData;
if (collectionConfig.schema) {
// TODO: remove for 2.0 stable release
if (
@ -94,7 +90,9 @@ export async function getEntryData(entry: Entry, collectionConfig: CollectionCon
});
}
// Use `safeParseAsync` to allow async transforms
const parsed = await collectionConfig.schema.safeParseAsync(entry.data, { errorMap });
const parsed = await collectionConfig.schema.safeParseAsync(entry.unvalidatedData, {
errorMap,
});
if (parsed.success) {
data = parsed.data;
} else {
@ -120,6 +118,10 @@ export async function getEntryData(entry: Entry, collectionConfig: CollectionCon
return data;
}
export function getContentEntryExts(settings: Pick<AstroSettings, 'contentEntryTypes'>) {
return settings.contentEntryTypes.map((t) => t.extensions).flat();
}
export class NoCollectionError extends Error {}
export function getEntryInfo(
@ -160,14 +162,15 @@ export function getEntryInfo({
export function getEntryType(
entryPath: string,
paths: Pick<ContentPaths, 'config' | 'contentDir'>
paths: Pick<ContentPaths, 'config' | 'contentDir'>,
contentFileExts: string[]
): 'content' | 'config' | 'ignored' | 'unsupported' {
const { ext, base } = path.parse(entryPath);
const fileUrl = pathToFileURL(entryPath);
if (hasUnderscoreBelowContentDirectoryPath(fileUrl, paths.contentDir) || isOnIgnoreList(base)) {
return 'ignored';
} else if ((contentFileExts as readonly string[]).includes(ext)) {
} else if (contentFileExts.includes(ext)) {
return 'content';
} else if (fileUrl.href === paths.config.url.href) {
return 'config';

View file

@ -1,6 +1,7 @@
import npath from 'node:path';
import { pathToFileURL } from 'url';
import type { Plugin } from 'vite';
import { AstroSettings } from '../@types/astro.js';
import { moduleIsTopLevelPage, walkParentInfos } from '../core/build/graph.js';
import { BuildInternals, getPageDataByViteID } from '../core/build/internal.js';
import { AstroBuildPlugin } from '../core/build/plugin.js';
@ -11,23 +12,30 @@ import { prependForwardSlash } from '../core/path.js';
import { getStylesForURL } from '../core/render/dev/css.js';
import { getScriptsForURL } from '../core/render/dev/scripts.js';
import {
contentFileExts,
LINKS_PLACEHOLDER,
PROPAGATED_ASSET_FLAG,
SCRIPTS_PLACEHOLDER,
STYLES_PLACEHOLDER,
} from './consts.js';
import { getContentEntryExts } from './utils.js';
function isPropagatedAsset(viteId: string): boolean {
function isPropagatedAsset(viteId: string, contentEntryExts: string[]): boolean {
const url = new URL(viteId, 'file://');
return (
url.searchParams.has(PROPAGATED_ASSET_FLAG) &&
contentFileExts.some((ext) => url.pathname.endsWith(ext))
contentEntryExts.some((ext) => url.pathname.endsWith(ext))
);
}
export function astroContentAssetPropagationPlugin({ mode }: { mode: string }): Plugin {
export function astroContentAssetPropagationPlugin({
mode,
settings,
}: {
mode: string;
settings: AstroSettings;
}): Plugin {
let devModuleLoader: ModuleLoader;
const contentEntryExts = getContentEntryExts(settings);
return {
name: 'astro:content-asset-propagation',
enforce: 'pre',
@ -37,7 +45,7 @@ export function astroContentAssetPropagationPlugin({ mode }: { mode: string }):
}
},
load(id) {
if (isPropagatedAsset(id)) {
if (isPropagatedAsset(id, contentEntryExts)) {
const basePath = id.split('?')[0];
const code = `
export async function getMod() {
@ -52,7 +60,7 @@ export function astroContentAssetPropagationPlugin({ mode }: { mode: string }):
},
async transform(code, id, options) {
if (!options?.ssr) return;
if (devModuleLoader && isPropagatedAsset(id)) {
if (devModuleLoader && isPropagatedAsset(id, contentEntryExts)) {
const basePath = id.split('?')[0];
if (!devModuleLoader.getModuleById(basePath)?.ssrModule) {
await devModuleLoader.import(basePath);

View file

@ -1,14 +1,16 @@
import * as devalue from 'devalue';
import type fsMod from 'node:fs';
import { extname } from 'node:path';
import { pathToFileURL } from 'url';
import type { Plugin } from 'vite';
import { AstroSettings } from '../@types/astro.js';
import { AstroSettings, ContentEntryType } from '../@types/astro.js';
import { AstroErrorData } from '../core/errors/errors-data.js';
import { AstroError } from '../core/errors/errors.js';
import { escapeViteEnvReferences, getFileInfo } from '../vite-plugin-utils/index.js';
import { contentFileExts, CONTENT_FLAG } from './consts.js';
import { CONTENT_FLAG } from './consts.js';
import {
ContentConfig,
getContentEntryExts,
getContentPaths,
getEntryData,
getEntryInfo,
@ -18,9 +20,9 @@ import {
parseFrontmatter,
} from './utils.js';
function isContentFlagImport(viteId: string) {
const { pathname, searchParams } = new URL(viteId, 'file://');
return searchParams.has(CONTENT_FLAG) && contentFileExts.some((ext) => pathname.endsWith(ext));
function isContentFlagImport(viteId: string, contentEntryExts: string[]) {
const { searchParams, pathname } = new URL(viteId, 'file://');
return searchParams.has(CONTENT_FLAG) && contentEntryExts.some((ext) => pathname.endsWith(ext));
}
export function astroContentImportPlugin({
@ -31,12 +33,20 @@ export function astroContentImportPlugin({
settings: AstroSettings;
}): Plugin {
const contentPaths = getContentPaths(settings.config, fs);
const contentEntryExts = getContentEntryExts(settings);
const contentEntryExtToParser: Map<string, ContentEntryType> = new Map();
for (const entryType of settings.contentEntryTypes) {
for (const ext of entryType.extensions) {
contentEntryExtToParser.set(ext, entryType);
}
}
return {
name: 'astro:content-imports',
async load(id) {
const { fileId } = getFileInfo(id, settings.config);
if (isContentFlagImport(id)) {
if (isContentFlagImport(id, contentEntryExts)) {
const observable = globalContentConfigObserver.get();
// Content config should be loaded before this plugin is used
@ -69,37 +79,48 @@ export function astroContentImportPlugin({
});
}
const rawContents = await fs.promises.readFile(fileId, 'utf-8');
const {
content: body,
data: unparsedData,
matter: rawData = '',
} = parseFrontmatter(rawContents, fileId);
const entryInfo = getEntryInfo({
const fileExt = extname(fileId);
if (!contentEntryExtToParser.has(fileExt)) {
throw new AstroError({
...AstroErrorData.UnknownContentCollectionError,
message: `No parser found for content entry ${JSON.stringify(
fileId
)}. Did you apply an integration for this file type?`,
});
}
const contentEntryParser = contentEntryExtToParser.get(fileExt)!;
const info = await contentEntryParser.getEntryInfo({
fileUrl: pathToFileURL(fileId),
contents: rawContents,
});
const generatedInfo = getEntryInfo({
entry: pathToFileURL(fileId),
contentDir: contentPaths.contentDir,
});
if (entryInfo instanceof Error) return;
if (generatedInfo instanceof Error) return;
const _internal = { filePath: fileId, rawData };
const partialEntry = { data: unparsedData, body, _internal, ...entryInfo };
const _internal = { filePath: fileId, rawData: info.rawData };
// TODO: move slug calculation to the start of the build
// to generate a performant lookup map for `getEntryBySlug`
const slug = getEntrySlug(partialEntry);
const slug = getEntrySlug({ ...generatedInfo, unvalidatedSlug: info.slug });
const collectionConfig = contentConfig?.collections[entryInfo.collection];
const collectionConfig = contentConfig?.collections[generatedInfo.collection];
const data = collectionConfig
? await getEntryData(partialEntry, collectionConfig)
: unparsedData;
? await getEntryData(
{ ...generatedInfo, _internal, unvalidatedData: info.data },
collectionConfig
)
: info.data;
const code = escapeViteEnvReferences(`
export const id = ${JSON.stringify(entryInfo.id)};
export const collection = ${JSON.stringify(entryInfo.collection)};
export const id = ${JSON.stringify(generatedInfo.id)};
export const collection = ${JSON.stringify(generatedInfo.collection)};
export const slug = ${JSON.stringify(slug)};
export const body = ${JSON.stringify(body)};
export const body = ${JSON.stringify(info.body)};
export const data = ${devalue.uneval(data) /* TODO: reuse astro props serializer */};
export const _internal = {
filePath: ${JSON.stringify(fileId)},
rawData: ${JSON.stringify(rawData)},
filePath: ${JSON.stringify(_internal.filePath)},
rawData: ${JSON.stringify(_internal.rawData)},
};
`);
return { code };
@ -109,11 +130,11 @@ export const _internal = {
viteServer.watcher.on('all', async (event, entry) => {
if (
['add', 'unlink', 'change'].includes(event) &&
getEntryType(entry, contentPaths) === 'config'
getEntryType(entry, contentPaths, contentEntryExts) === 'config'
) {
// Content modules depend on config, so we need to invalidate them.
for (const modUrl of viteServer.moduleGraph.urlToModuleMap.keys()) {
if (isContentFlagImport(modUrl)) {
if (isContentFlagImport(modUrl, contentEntryExts)) {
const mod = await viteServer.moduleGraph.getModuleByUrl(modUrl);
if (mod) {
viteServer.moduleGraph.invalidateModule(mod);
@ -124,7 +145,7 @@ export const _internal = {
});
},
async transform(code, id) {
if (isContentFlagImport(id)) {
if (isContentFlagImport(id, contentEntryExts)) {
// Escape before Rollup internal transform.
// Base on MUCH trial-and-error, inspired by MDX integration 2-step transform.
return { code: escapeViteEnvReferences(code) };

View file

@ -4,8 +4,8 @@ import type { Plugin } from 'vite';
import { normalizePath } from 'vite';
import type { AstroSettings } from '../@types/astro.js';
import { appendForwardSlash, prependForwardSlash } from '../core/path.js';
import { contentFileExts, VIRTUAL_MODULE_ID } from './consts.js';
import { getContentPaths } from './utils.js';
import { VIRTUAL_MODULE_ID } from './consts.js';
import { getContentEntryExts, getContentPaths } from './utils.js';
interface AstroContentVirtualModPluginParams {
settings: AstroSettings;
@ -22,7 +22,14 @@ export function astroContentVirtualModPlugin({
)
)
);
const entryGlob = `${relContentDir}**/*{${contentFileExts.join(',')}}`;
const contentEntryExts = getContentEntryExts(settings);
const extGlob =
contentEntryExts.length === 1
? // Wrapping {...} breaks when there is only one extension
contentEntryExts[0]
: `{${contentEntryExts.join(',')}}`;
const entryGlob = `${relContentDir}**/*${extGlob}`;
const virtualModContents = fsMod
.readFileSync(contentPaths.virtualModTemplate, 'utf-8')
.replace('@@CONTENT_DIR@@', relContentDir)

View file

@ -6,6 +6,7 @@ import jsxRenderer from '../../jsx/renderer.js';
import { createDefaultDevConfig } from './config.js';
import { AstroTimer } from './timer.js';
import { loadTSConfig } from './tsconfig.js';
import { markdownContentEntryType } from '../../vite-plugin-markdown/content-entry-type.js';
export function createBaseSettings(config: AstroConfig): AstroSettings {
return {
@ -16,6 +17,7 @@ export function createBaseSettings(config: AstroConfig): AstroSettings {
adapter: undefined,
injectedRoutes: [],
pageExtensions: ['.astro', '.html', ...SUPPORTED_MARKDOWN_FILE_EXTENSIONS],
contentEntryTypes: [markdownContentEntryType],
renderers: [jsxRenderer],
scripts: [],
watchFiles: [],

View file

@ -114,7 +114,7 @@ export async function createVite(
astroInjectEnvTsPlugin({ settings, logging, fs }),
astroContentVirtualModPlugin({ settings }),
astroContentImportPlugin({ fs, settings }),
astroContentAssetPropagationPlugin({ mode }),
astroContentAssetPropagationPlugin({ mode, settings }),
],
publicDir: fileURLToPath(settings.config.publicDir),
root: fileURLToPath(settings.config.root),

View file

@ -150,9 +150,15 @@ export async function getViteErrorPayload(err: ErrorWithMetadata): Promise<Astro
: undefined;
const highlighter = await getHighlighter({ theme: 'css-variables' });
let highlighterLang = err.loc?.file?.split('.').pop();
if (['cjs', 'mjs'].includes(highlighterLang ?? '')) {
// Shiki does not support `mjs` or `cjs` aliases by default.
// Map these to `js` instead.
highlighterLang = 'js';
}
const highlightedCode = err.fullCode
? highlighter.codeToHtml(err.fullCode, {
lang: err.loc?.file?.split('.').pop(),
lang: highlighterLang,
lineOptions: err.loc?.line ? [{ line: err.loc.line, classes: ['error-line'] }] : undefined,
})
: undefined;

View file

@ -8,6 +8,7 @@ import {
AstroRenderer,
AstroSettings,
BuildConfig,
ContentEntryType,
HookParameters,
RouteData,
} from '../@types/astro.js';
@ -95,16 +96,31 @@ export async function runHookConfigSetup({
updatedSettings.watchFiles.push(path instanceof URL ? fileURLToPath(path) : path);
},
};
// Semi-private `addPageExtension` hook
function addPageExtension(...input: (string | string[])[]) {
const exts = (input.flat(Infinity) as string[]).map((ext) => `.${ext.replace(/^\./, '')}`);
updatedSettings.pageExtensions.push(...exts);
}
Object.defineProperty(hooks, 'addPageExtension', {
value: addPageExtension,
writable: false,
enumerable: false,
});
// Public, intentionally undocumented hooks - not subject to semver.
// Intended for internal integrations (ex. `@astrojs/mdx`),
// though accessible to integration authors if discovered.
(function applySemiPrivateHooks() {
function addPageExtension(...input: (string | string[])[]) {
const exts = (input.flat(Infinity) as string[]).map((ext) => `.${ext.replace(/^\./, '')}`);
updatedSettings.pageExtensions.push(...exts);
}
function addContentEntryType(contentEntryType: ContentEntryType) {
updatedSettings.contentEntryTypes.push(contentEntryType);
}
Object.defineProperty(hooks, 'addPageExtension', {
value: addPageExtension,
writable: false,
enumerable: false,
});
Object.defineProperty(hooks, 'addContentEntryType', {
value: addContentEntryType,
writable: false,
enumerable: false,
});
})();
await withTakingALongTimeMsg({
name: integration.name,
hookResult: integration.hooks['astro:config:setup'](hooks),

View file

@ -0,0 +1,16 @@
import { fileURLToPath } from 'node:url';
import { ContentEntryType } from '../@types/astro.js';
import { parseFrontmatter } from '../content/utils.js';
export const markdownContentEntryType: ContentEntryType = {
extensions: ['.md'],
async getEntryInfo({ fileUrl, contents }: { fileUrl: URL; contents: string }) {
const parsed = parseFrontmatter(contents, fileURLToPath(fileUrl));
return {
data: parsed.data,
body: parsed.content,
slug: parsed.data.slug,
rawData: parsed.matter,
};
},
};

View file

@ -3,7 +3,6 @@
"version": "0.0.0",
"private": true,
"dependencies": {
"astro": "workspace:*",
"@astrojs/mdx": "workspace:*"
"astro": "workspace:*"
}
}

View file

@ -25,13 +25,15 @@ const fixtures = [
},
];
const contentFileExts = ['.md', '.mdx'];
describe('Content Collections - getEntryType', () => {
fixtures.forEach(({ title, contentPaths }) => {
describe(title, () => {
it('Returns "content" for Markdown files', () => {
for (const entryPath of ['blog/first-post.md', 'blog/first-post.mdx']) {
const entry = fileURLToPath(new URL(entryPath, contentPaths.contentDir));
const type = getEntryType(entry, contentPaths);
const type = getEntryType(entry, contentPaths, contentFileExts);
expect(type).to.equal('content');
}
});
@ -39,44 +41,44 @@ describe('Content Collections - getEntryType', () => {
it('Returns "content" for Markdown files in nested directories', () => {
for (const entryPath of ['blog/2021/01/01/index.md', 'blog/2021/01/01/index.mdx']) {
const entry = fileURLToPath(new URL(entryPath, contentPaths.contentDir));
const type = getEntryType(entry, contentPaths);
const type = getEntryType(entry, contentPaths, contentFileExts);
expect(type).to.equal('content');
}
});
it('Returns "config" for config files', () => {
const entry = fileURLToPath(contentPaths.config.url);
const type = getEntryType(entry, contentPaths);
const type = getEntryType(entry, contentPaths, contentFileExts);
expect(type).to.equal('config');
});
it('Returns "unsupported" for non-Markdown files', () => {
const entry = fileURLToPath(new URL('blog/robots.txt', contentPaths.contentDir));
const type = getEntryType(entry, contentPaths);
const type = getEntryType(entry, contentPaths, contentFileExts);
expect(type).to.equal('unsupported');
});
it('Returns "ignored" for .DS_Store', () => {
const entry = fileURLToPath(new URL('blog/.DS_Store', contentPaths.contentDir));
const type = getEntryType(entry, contentPaths);
const type = getEntryType(entry, contentPaths, contentFileExts);
expect(type).to.equal('ignored');
});
it('Returns "ignored" for unsupported files using an underscore', () => {
const entry = fileURLToPath(new URL('blog/_draft-robots.txt', contentPaths.contentDir));
const type = getEntryType(entry, contentPaths);
const type = getEntryType(entry, contentPaths, contentFileExts);
expect(type).to.equal('ignored');
});
it('Returns "ignored" when using underscore on file name', () => {
const entry = fileURLToPath(new URL('blog/_first-post.md', contentPaths.contentDir));
const type = getEntryType(entry, contentPaths);
const type = getEntryType(entry, contentPaths, contentFileExts);
expect(type).to.equal('ignored');
});
it('Returns "ignored" when using underscore on directory name', () => {
const entry = fileURLToPath(new URL('blog/_draft/first-post.md', contentPaths.contentDir));
const type = getEntryType(entry, contentPaths);
const type = getEntryType(entry, contentPaths, contentFileExts);
expect(type).to.equal('ignored');
});
});

View file

@ -0,0 +1,614 @@
# @astrojs/mdx
## 0.16.0
### Minor Changes
- [#6050](https://github.com/withastro/astro/pull/6050) [`2ab32b59e`](https://github.com/withastro/astro/commit/2ab32b59ef0a28d34757f2c2adb9cf2baa86855e) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Fix: load syntax highlighters after MDX remark plugins. This keeps MDX consistent with Astro's markdown behavior.
### Patch Changes
- [#6062](https://github.com/withastro/astro/pull/6062) [`c6cf847bd`](https://github.com/withastro/astro/commit/c6cf847bd0b6bef3c51a5710fba5ca43b11e46f9) Thanks [@delucis](https://github.com/delucis)! - Update MDX README
## 0.15.2
### Patch Changes
- [#5478](https://github.com/withastro/astro/pull/5478) [`1c7eef308`](https://github.com/withastro/astro/commit/1c7eef308e808aa5ed4662b53e67ec8d1b814d1f) Thanks [@nemo0](https://github.com/nemo0)! - Update READMEs for consistency
## 0.15.1
### Patch Changes
- [#5978](https://github.com/withastro/astro/pull/5978) [`7abb1e905`](https://github.com/withastro/astro/commit/7abb1e9056c4b4fd0abfced347df32a41cdfbf28) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fix MDX heading IDs generation when using a frontmatter reference
- Updated dependencies [[`7abb1e905`](https://github.com/withastro/astro/commit/7abb1e9056c4b4fd0abfced347df32a41cdfbf28)]:
- @astrojs/markdown-remark@2.0.1
## 0.15.0
### Minor Changes
- [#5684](https://github.com/withastro/astro/pull/5684) [`a9c292026`](https://github.com/withastro/astro/commit/a9c2920264e36cc5dc05f4adc1912187979edb0d) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Refine Markdown and MDX configuration options for ease-of-use. & [#5769](https://github.com/withastro/astro/pull/5769) [`93e633922`](https://github.com/withastro/astro/commit/93e633922c2e449df3bb2357b3683af1d3c0e07b) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Introduce a `smartypants` flag to opt-out of Astro's default SmartyPants plugin.
- **Markdown**
- **Replace the `extendDefaultPlugins` option** with a `gfm` boolean and a `smartypants` boolean. These are enabled by default, and can be disabled to remove GitHub-Flavored Markdown and SmartyPants.
- Ensure GitHub-Flavored Markdown and SmartyPants are applied whether or not custom `remarkPlugins` or `rehypePlugins` are configured. If you want to apply custom plugins _and_ remove Astro's default plugins, manually set `gfm: false` and `smartypants: false` in your config.
- **Migrate `extendDefaultPlugins` to `gfm` and `smartypants`**
You may have disabled Astro's built-in plugins (GitHub-Flavored Markdown and Smartypants) with the `extendDefaultPlugins` option. This has now been split into 2 flags to disable each plugin individually:
- `markdown.gfm` to disable GitHub-Flavored Markdown
- `markdown.smartypants` to disable SmartyPants
```diff
// astro.config.mjs
import { defineConfig } from 'astro/config';
export default defineConfig({
markdown: {
- extendDefaultPlugins: false,
+ smartypants: false,
+ gfm: false,
}
});
```
Additionally, applying remark and rehype plugins **no longer disables** `gfm` and `smartypants`. You will need to opt-out manually by setting `gfm` and `smartypants` to `false`.
- **MDX**
- Support _all_ Markdown configuration options (except `drafts`) from your MDX integration config. This includes `syntaxHighlighting` and `shikiConfig` options to further customize the MDX renderer.
- Simplify `extendPlugins` to an `extendMarkdownConfig` option. MDX options will default to their equivalent in your Markdown config. By setting `extendMarkdownConfig` to false, you can "eject" to set your own syntax highlighting, plugins, and more.
- **Migrate MDX's `extendPlugins` to `extendMarkdownConfig`**
You may have used the `extendPlugins` option to manage plugin defaults in MDX. This has been replaced by 3 flags:
- `extendMarkdownConfig` (`true` by default) to toggle Markdown config inheritance. This replaces the `extendPlugins: 'markdown'` option.
- `gfm` (`true` by default) and `smartypants` (`true` by default) to toggle GitHub-Flavored Markdown and SmartyPants in MDX. This replaces the `extendPlugins: 'defaults'` option.
- [#5687](https://github.com/withastro/astro/pull/5687) [`e2019be6f`](https://github.com/withastro/astro/commit/e2019be6ffa46fa33d92cfd346f9ecbe51bb7144) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Give remark and rehype plugins access to user frontmatter via frontmatter injection. This means `data.astro.frontmatter` is now the _complete_ Markdown or MDX document's frontmatter, rather than an empty object.
This allows plugin authors to modify existing frontmatter, or compute new properties based on other properties. For example, say you want to compute a full image URL based on an `imageSrc` slug in your document frontmatter:
```ts
export function remarkInjectSocialImagePlugin() {
return function (tree, file) {
const { frontmatter } = file.data.astro;
frontmatter.socialImageSrc = new URL(frontmatter.imageSrc, 'https://my-blog.com/').pathname;
};
}
```
When using Content Collections, you can access this modified frontmatter using the `remarkPluginFrontmatter` property returned when rendering an entry.
**Migration instructions**
Plugin authors should now **check for user frontmatter when applying defaults.**
For example, say a remark plugin wants to apply a default `title` if none is present. Add a conditional to check if the property is present, and update if none exists:
```diff
export function remarkInjectTitlePlugin() {
return function (tree, file) {
const { frontmatter } = file.data.astro;
+ if (!frontmatter.title) {
frontmatter.title = 'Default title';
+ }
}
}
```
This differs from previous behavior, where a Markdown file's frontmatter would _always_ override frontmatter injected via remark or reype.
- [#5891](https://github.com/withastro/astro/pull/5891) [`05caf445d`](https://github.com/withastro/astro/commit/05caf445d4d2728f1010aeb2179a9e756c2fd17d) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Remove deprecated Markdown APIs from Astro v0.X. This includes `getHeaders()`, the `.astro` property for layouts, and the `rawContent()` and `compiledContent()` error messages for MDX.
- [#5782](https://github.com/withastro/astro/pull/5782) [`1f92d64ea`](https://github.com/withastro/astro/commit/1f92d64ea35c03fec43aff64eaf704dc5a9eb30a) Thanks [@Princesseuh](https://github.com/Princesseuh)! - Remove support for Node 14. Minimum supported Node version is now >=16.12.0
- [#5825](https://github.com/withastro/astro/pull/5825) [`52209ca2a`](https://github.com/withastro/astro/commit/52209ca2ad72a30854947dcb3a90ab4db0ac0a6f) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Baseline the experimental `contentCollections` flag. You're free to remove this from your astro config!
```diff
import { defineConfig } from 'astro/config';
export default defineConfig({
- experimental: { contentCollections: true }
})
```
### Patch Changes
- [#5837](https://github.com/withastro/astro/pull/5837) [`12f65a4d5`](https://github.com/withastro/astro/commit/12f65a4d55e3fd2993c2f67b18794dd536280c69) Thanks [@giuseppelt](https://github.com/giuseppelt)! - fix shiki css class replace logic
- [#5741](https://github.com/withastro/astro/pull/5741) [`000d3e694`](https://github.com/withastro/astro/commit/000d3e6940839c2aebba1984e6fb3b133cec6749) Thanks [@delucis](https://github.com/delucis)! - Fix broken links in README
- Updated dependencies [[`93e633922`](https://github.com/withastro/astro/commit/93e633922c2e449df3bb2357b3683af1d3c0e07b), [`e2019be6f`](https://github.com/withastro/astro/commit/e2019be6ffa46fa33d92cfd346f9ecbe51bb7144), [`1f92d64ea`](https://github.com/withastro/astro/commit/1f92d64ea35c03fec43aff64eaf704dc5a9eb30a), [`12f65a4d5`](https://github.com/withastro/astro/commit/12f65a4d55e3fd2993c2f67b18794dd536280c69), [`16107b6a1`](https://github.com/withastro/astro/commit/16107b6a10514ef1b563e585ec9add4b14f42b94), [`a9c292026`](https://github.com/withastro/astro/commit/a9c2920264e36cc5dc05f4adc1912187979edb0d), [`52209ca2a`](https://github.com/withastro/astro/commit/52209ca2ad72a30854947dcb3a90ab4db0ac0a6f), [`7572f7402`](https://github.com/withastro/astro/commit/7572f7402238da37de748be58d678fedaf863b53)]:
- @astrojs/markdown-remark@2.0.0
- @astrojs/prism@2.0.0
## 1.0.0-beta.2
<details>
<summary>See changes in 1.0.0-beta.2</summary>
### Major Changes
- [#5825](https://github.com/withastro/astro/pull/5825) [`52209ca2a`](https://github.com/withastro/astro/commit/52209ca2ad72a30854947dcb3a90ab4db0ac0a6f) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Baseline the experimental `contentCollections` flag. You're free to remove this from your astro config!
```diff
import { defineConfig } from 'astro/config';
export default defineConfig({
- experimental: { contentCollections: true }
})
```
### Minor Changes
- [#5782](https://github.com/withastro/astro/pull/5782) [`1f92d64ea`](https://github.com/withastro/astro/commit/1f92d64ea35c03fec43aff64eaf704dc5a9eb30a) Thanks [@Princesseuh](https://github.com/Princesseuh)! - Remove support for Node 14. Minimum supported Node version is now >=16.12.0
### Patch Changes
- [#5837](https://github.com/withastro/astro/pull/5837) [`12f65a4d5`](https://github.com/withastro/astro/commit/12f65a4d55e3fd2993c2f67b18794dd536280c69) Thanks [@giuseppelt](https://github.com/giuseppelt)! - fix shiki css class replace logic
- Updated dependencies [[`1f92d64ea`](https://github.com/withastro/astro/commit/1f92d64ea35c03fec43aff64eaf704dc5a9eb30a), [`12f65a4d5`](https://github.com/withastro/astro/commit/12f65a4d55e3fd2993c2f67b18794dd536280c69), [`16107b6a1`](https://github.com/withastro/astro/commit/16107b6a10514ef1b563e585ec9add4b14f42b94), [`52209ca2a`](https://github.com/withastro/astro/commit/52209ca2ad72a30854947dcb3a90ab4db0ac0a6f), [`7572f7402`](https://github.com/withastro/astro/commit/7572f7402238da37de748be58d678fedaf863b53)]:
- @astrojs/prism@2.0.0-beta.0
- @astrojs/markdown-remark@2.0.0-beta.2
</details>
## 0.15.0-beta.1
<details>
<summary>See changes in 0.15.0-beta.1</summary>
### Minor Changes
- [#5769](https://github.com/withastro/astro/pull/5769) [`93e633922`](https://github.com/withastro/astro/commit/93e633922c2e449df3bb2357b3683af1d3c0e07b) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Introduce a `smartypants` flag to opt-out of Astro's default SmartyPants plugin.
```js
{
markdown: {
smartypants: false,
}
}
```
#### Migration
You may have disabled Astro's built-in plugins (GitHub-Flavored Markdown and Smartypants) with the `extendDefaultPlugins` option. This has now been split into 2 flags to disable each plugin individually:
- `markdown.gfm` to disable GitHub-Flavored Markdown
- `markdown.smartypants` to disable SmartyPants
```diff
// astro.config.mjs
import { defineConfig } from 'astro/config';
export default defineConfig({
markdown: {
- extendDefaultPlugins: false,
+ smartypants: false,
+ gfm: false,
}
});
```
### Patch Changes
- [#5741](https://github.com/withastro/astro/pull/5741) [`000d3e694`](https://github.com/withastro/astro/commit/000d3e6940839c2aebba1984e6fb3b133cec6749) Thanks [@delucis](https://github.com/delucis)! - Fix broken links in README
- Updated dependencies [[`93e633922`](https://github.com/withastro/astro/commit/93e633922c2e449df3bb2357b3683af1d3c0e07b)]:
- @astrojs/markdown-remark@2.0.0-beta.1
</details>
## 0.15.0-beta.0
<details>
<summary>See changes in 0.15.0-beta.0</summary>
### Minor Changes
- [#5687](https://github.com/withastro/astro/pull/5687) [`e2019be6f`](https://github.com/withastro/astro/commit/e2019be6ffa46fa33d92cfd346f9ecbe51bb7144) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Give remark and rehype plugins access to user frontmatter via frontmatter injection. This means `data.astro.frontmatter` is now the _complete_ Markdown or MDX document's frontmatter, rather than an empty object.
This allows plugin authors to modify existing frontmatter, or compute new properties based on other properties. For example, say you want to compute a full image URL based on an `imageSrc` slug in your document frontmatter:
```ts
export function remarkInjectSocialImagePlugin() {
return function (tree, file) {
const { frontmatter } = file.data.astro;
frontmatter.socialImageSrc = new URL(frontmatter.imageSrc, 'https://my-blog.com/').pathname;
};
}
```
#### Content Collections - new `remarkPluginFrontmatter` property
We have changed _inject_ frontmatter to _modify_ frontmatter in our docs to improve discoverability. This is based on support forum feedback, where "injection" is rarely the term used.
To reflect this, the `injectedFrontmatter` property has been renamed to `remarkPluginFrontmatter`. This should clarify this plugin is still separate from the `data` export Content Collections expose today.
#### Migration instructions
Plugin authors should now **check for user frontmatter when applying defaults.**
For example, say a remark plugin wants to apply a default `title` if none is present. Add a conditional to check if the property is present, and update if none exists:
```diff
export function remarkInjectTitlePlugin() {
return function (tree, file) {
const { frontmatter } = file.data.astro;
+ if (!frontmatter.title) {
frontmatter.title = 'Default title';
+ }
}
}
```
This differs from previous behavior, where a Markdown file's frontmatter would _always_ override frontmatter injected via remark or reype.
- [#5684](https://github.com/withastro/astro/pull/5684) [`a9c292026`](https://github.com/withastro/astro/commit/a9c2920264e36cc5dc05f4adc1912187979edb0d) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Refine Markdown and MDX configuration options for ease-of-use.
#### Markdown
- **Remove `remark-smartypants`** from Astro's default Markdown plugins.
- **Replace the `extendDefaultPlugins` option** with a simplified `gfm` boolean. This is enabled by default, and can be disabled to remove GitHub-Flavored Markdown.
- Ensure GitHub-Flavored Markdown is applied whether or not custom `remarkPlugins` or `rehypePlugins` are configured. If you want to apply custom plugins _and_ remove GFM, manually set `gfm: false` in your config.
#### MDX
- Support _all_ Markdown configuration options (except `drafts`) from your MDX integration config. This includes `syntaxHighlighting` and `shikiConfig` options to further customize the MDX renderer.
- Simplify `extendDefaults` to an `extendMarkdownConfig` option. MDX options will default to their equivalent in your Markdown config. By setting `extendMarkdownConfig` to false, you can "eject" to set your own syntax highlighting, plugins, and more.
#### Migration
To preserve your existing Markdown and MDX setup, you may need some configuration changes:
##### Smartypants manual installation
[Smartypants](https://github.com/silvenon/remark-smartypants) has been removed from Astro's default setup. If you rely on this plugin, [install `remark-smartypants`](https://github.com/silvenon/remark-smartypants#installing) and apply to your `astro.config.*`:
```diff
// astro.config.mjs
import { defineConfig } from 'astro/config';
+ import smartypants from 'remark-smartypants';
export default defineConfig({
markdown: {
+ remarkPlugins: [smartypants],
}
});
```
##### Migrate `extendDefaultPlugins` to `gfm`
You may have disabled Astro's built-in plugins (GitHub-Flavored Markdown and Smartypants) with the `extendDefaultPlugins` option. Since Smartypants has been removed, this has been renamed to `gfm`.
```diff
// astro.config.mjs
import { defineConfig } from 'astro/config';
export default defineConfig({
markdown: {
- extendDefaultPlugins: false,
+ gfm: false,
}
});
```
Additionally, applying remark and rehype plugins **no longer disables** `gfm`. You will need to opt-out manually by setting `gfm` to `false`.
##### Migrate MDX's `extendPlugins` to `extendMarkdownConfig`
You may have used the `extendPlugins` option to manage plugin defaults in MDX. This has been replaced by 2 flags:
- `extendMarkdownConfig` (`true` by default) to toggle Markdown config inheritance. This replaces the `extendPlugins: 'markdown'` option.
- `gfm` (`true` by default) to toggle GitHub-Flavored Markdown in MDX. This replaces the `extendPlugins: 'defaults'` option.
### Patch Changes
- Updated dependencies [[`e2019be6f`](https://github.com/withastro/astro/commit/e2019be6ffa46fa33d92cfd346f9ecbe51bb7144), [`a9c292026`](https://github.com/withastro/astro/commit/a9c2920264e36cc5dc05f4adc1912187979edb0d)]:
- @astrojs/markdown-remark@2.0.0-beta.0
</details>
## 0.14.0
### Minor Changes
- [#5654](https://github.com/withastro/astro/pull/5654) [`2c65b433b`](https://github.com/withastro/astro/commit/2c65b433bf840a1bb93b0a1947df5949e33512ff) Thanks [@delucis](https://github.com/delucis)! - Run heading ID injection after user plugins
⚠️ BREAKING CHANGE ⚠️
If you are using a rehype plugin that depends on heading IDs injected by Astro, the IDs will no longer be available when your plugin runs by default.
To inject IDs before your plugins run, import and add the `rehypeHeadingIds` plugin to your `rehypePlugins` config:
```diff
// astro.config.mjs
+ import { rehypeHeadingIds } from '@astrojs/markdown-remark';
import mdx from '@astrojs/mdx';
export default {
integrations: [mdx()],
markdown: {
rehypePlugins: [
+ rehypeHeadingIds,
otherPluginThatReliesOnHeadingIDs,
],
},
}
```
### Patch Changes
- [#5667](https://github.com/withastro/astro/pull/5667) [`a5ba4af79`](https://github.com/withastro/astro/commit/a5ba4af79930145f4edf66d45cd40ddad045cc86) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Chore: remove verbose "Now interiting Markdown plugins..." logs
- [#5648](https://github.com/withastro/astro/pull/5648) [`853081d1c`](https://github.com/withastro/astro/commit/853081d1c857d8ad8a9634c37ed8fd123d32d241) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Prevent relative image paths in `src/content/`
- Updated dependencies [[`853081d1c`](https://github.com/withastro/astro/commit/853081d1c857d8ad8a9634c37ed8fd123d32d241), [`2c65b433b`](https://github.com/withastro/astro/commit/2c65b433bf840a1bb93b0a1947df5949e33512ff)]:
- @astrojs/markdown-remark@1.2.0
## 0.13.0
### Minor Changes
- [#5291](https://github.com/withastro/astro/pull/5291) [`5ec0f6ed5`](https://github.com/withastro/astro/commit/5ec0f6ed55b0a14a9663a90a03428345baf126bd) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Introduce Content Collections experimental API
- Organize your Markdown and MDX content into easy-to-manage collections.
- Add type safety to your frontmatter with schemas.
- Generate landing pages, static routes, and SSR endpoints from your content using the collection query APIs.
## 0.12.2
### Patch Changes
- [#5586](https://github.com/withastro/astro/pull/5586) [`f4ff69a3c`](https://github.com/withastro/astro/commit/f4ff69a3cd874c8804c6d01c7cbbaed8a8e90be7) Thanks [@delucis](https://github.com/delucis)! - Fix link in MDX integration README
- [#5570](https://github.com/withastro/astro/pull/5570) [`3f811eb68`](https://github.com/withastro/astro/commit/3f811eb682d55bd1f908f9b4bc3b795d2859d713) Thanks [@sarah11918](https://github.com/sarah11918)! - Revise README
## 0.12.1
### Patch Changes
- [#5522](https://github.com/withastro/astro/pull/5522) [`efc4363e0`](https://github.com/withastro/astro/commit/efc4363e0baf7f92900e20af339811bb3df42b0e) Thanks [@delucis](https://github.com/delucis)! - Support use of `<Fragment>` in MDX files rendered with `<Content />` component
## 0.12.0
### Minor Changes
- [#5427](https://github.com/withastro/astro/pull/5427) [`2a1c085b1`](https://github.com/withastro/astro/commit/2a1c085b199f24e34424ec8c19041c03602c53c5) Thanks [@backflip](https://github.com/backflip)! - Uses remark-rehype options from astro.config.mjs
### Patch Changes
- [#5448](https://github.com/withastro/astro/pull/5448) [`ef2ffc7ae`](https://github.com/withastro/astro/commit/ef2ffc7ae9ff554860238ecd2fb3bf6d82b5801b) Thanks [@delucis](https://github.com/delucis)! - Fix broken link in README
## 0.11.6
### Patch Changes
- [#5335](https://github.com/withastro/astro/pull/5335) [`dca762cf7`](https://github.com/withastro/astro/commit/dca762cf734a657d8f126fd6958892b6163a4f67) Thanks [@bluwy](https://github.com/bluwy)! - Preserve code element node `data.meta` in `properties.metastring` for rehype syntax highlighters, like `rehype-pretty-code``
## 0.11.5
### Patch Changes
- [#5146](https://github.com/withastro/astro/pull/5146) [`308e565ad`](https://github.com/withastro/astro/commit/308e565ad39957e3353d72ca5d3bbce1a1b45008) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Support recmaPlugins config option
## 0.11.4
### Patch Changes
- [#4953](https://github.com/withastro/astro/pull/4953) [`a59731995`](https://github.com/withastro/astro/commit/a59731995b93ae69c21dc3adc5c8b482b466d12e) Thanks [@bluwy](https://github.com/bluwy)! - Log markdown hints with console.info
## 0.11.3
### Patch Changes
- [#4842](https://github.com/withastro/astro/pull/4842) [`812658ad2`](https://github.com/withastro/astro/commit/812658ad2ab3732a99e35c4fd903e302e723db46) Thanks [@bluwy](https://github.com/bluwy)! - Add missing dependencies, support strict dependency installation (e.g. pnpm)
## 0.11.2
### Patch Changes
- [#4700](https://github.com/withastro/astro/pull/4700) [`e5f71142e`](https://github.com/withastro/astro/commit/e5f71142eb62bd72456e889dad5774347c3753f2) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Document MDXLayoutProps utility type
- [#4858](https://github.com/withastro/astro/pull/4858) [`58a2dca22`](https://github.com/withastro/astro/commit/58a2dca2286cb14f6211cf51267c02447e78433a) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Correctly parse import.meta.env in MDX files
## 0.11.1
### Patch Changes
- [#4588](https://github.com/withastro/astro/pull/4588) [`db38f61b2`](https://github.com/withastro/astro/commit/db38f61b2b2dc55f03b28797d19b163b1940f1c8) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Fix: Add GFM and Smartypants to MDX by default
## 0.11.0
### Minor Changes
- [#4504](https://github.com/withastro/astro/pull/4504) [`8f8dff4d3`](https://github.com/withastro/astro/commit/8f8dff4d339a3a12ee155d81a97132032ef3b622) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Introduce new `extendPlugins` configuration option. This defaults to inheriting all remark and rehype plugins from your `markdown` config, with options to use either Astro's defaults or no inheritance at all.
## 0.10.3
### Patch Changes
- [#4519](https://github.com/withastro/astro/pull/4519) [`a2e8e76c3`](https://github.com/withastro/astro/commit/a2e8e76c303e8d6f39c24c122905a10f06907997) Thanks [@JuanM04](https://github.com/JuanM04)! - Upgraded Shiki to v0.11.1
- [#4530](https://github.com/withastro/astro/pull/4530) [`8504cd79b`](https://github.com/withastro/astro/commit/8504cd79b708e0d3bf1a2bb4ff9b86936bdd692b) Thanks [@kylebutts](https://github.com/kylebutts)! - Add custom components to README
## 0.10.2
### Patch Changes
- [#4423](https://github.com/withastro/astro/pull/4423) [`d4cd7a59f`](https://github.com/withastro/astro/commit/d4cd7a59fd38d411c442a818cfaab40f74106628) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Update Markdown type signature to match new markdown plugin,and update top-level layout props for better alignment
## 0.10.2-next.0
### Patch Changes
- [#4423](https://github.com/withastro/astro/pull/4423) [`d4cd7a59f`](https://github.com/withastro/astro/commit/d4cd7a59fd38d411c442a818cfaab40f74106628) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Update Markdown type signature to match new markdown plugin,and update top-level layout props for better alignment
## 0.10.1
### Patch Changes
- [#4443](https://github.com/withastro/astro/pull/4443) [`adb207979`](https://github.com/withastro/astro/commit/adb20797962c280d4d38f335f577fd52a1b48d4b) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Fix MDX style imports when layout is not applied
* [#4428](https://github.com/withastro/astro/pull/4428) [`a2414bf59`](https://github.com/withastro/astro/commit/a2414bf59e2e2cd633aece68e724401c4ad281b9) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Fix dev server reload performance when globbing from an MDX layout
## 0.10.0
### Minor Changes
- [#4292](https://github.com/withastro/astro/pull/4292) [`f1a52c18a`](https://github.com/withastro/astro/commit/f1a52c18afe66e6d310743ae6884be76f69be265) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Switch from Shiki Twoslash to Astro's Shiki Markdown highlighter
## 0.9.0
### Minor Changes
- [#4268](https://github.com/withastro/astro/pull/4268) [`f7afdb889`](https://github.com/withastro/astro/commit/f7afdb889fe4e97177958c8ec92f80c5f6e5cb51) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Align MD with MDX on layout props and "glob" import results:
- Add `Content` to MDX
- Add `file` and `url` to MDX frontmatter (layout import only)
- Update glob types to reflect differences (lack of `rawContent` and `compiledContent`)
### Patch Changes
- [#4272](https://github.com/withastro/astro/pull/4272) [`24d2f7a6e`](https://github.com/withastro/astro/commit/24d2f7a6e6700c10c863f826f37bb653d70e3a83) Thanks [@natemoo-re](https://github.com/natemoo-re)! - Properly handle hydration for namespaced components
## 0.8.3
### Patch Changes
- [#4248](https://github.com/withastro/astro/pull/4248) [`869d00935`](https://github.com/withastro/astro/commit/869d0093596b709cfcc1a1a95ee631b48d6d1c26) Thanks [@svemat01](https://github.com/svemat01)! - Load builtin rehype plugins before user plugins instead of after
* [#4255](https://github.com/withastro/astro/pull/4255) [`411612808`](https://github.com/withastro/astro/commit/4116128082121ee276d51cb245bf8095be4728a1) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Pass injected frontmatter from remark and rehype plugins to layouts
* Updated dependencies [[`1f0dd31d9`](https://github.com/withastro/astro/commit/1f0dd31d9239b5e3dca99c88d021e7a9a3e2054d)]:
- @astrojs/prism@1.0.1
## 0.8.2
### Patch Changes
- [#4237](https://github.com/withastro/astro/pull/4237) [`9d5ab5508`](https://github.com/withastro/astro/commit/9d5ab55086964fbede17da3d78c209c6d8d13711) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Update "Astro.props.content" -> "Astro.props.frontmatter" in README
## 0.8.1
### Patch Changes
- Updated dependencies [[`04ad44563`](https://github.com/withastro/astro/commit/04ad445632c67bdd60c1704e1e0dcbcaa27b9308)]:
- @astrojs/prism@1.0.0
## 0.8.0
### Minor Changes
- [#4204](https://github.com/withastro/astro/pull/4204) [`4c2ca5352`](https://github.com/withastro/astro/commit/4c2ca5352d0c4119ed2a9e5e0b78ce71eb1b414a) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Remove `frontmatterOptions` from MDX config
### Patch Changes
- [#4205](https://github.com/withastro/astro/pull/4205) [`6c9736cbc`](https://github.com/withastro/astro/commit/6c9736cbc90162f1de3ebccd7cfe98332749b639) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Add frontmatter injection instructions to README
## 0.7.0
### Minor Changes
- [#4176](https://github.com/withastro/astro/pull/4176) [`2675b8633`](https://github.com/withastro/astro/commit/2675b8633c5d5c45b237ec87940d5eaf1bfb1b4b) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Support frontmatter injection for MD and MDX using remark and rehype plugins
### Patch Changes
- [#4181](https://github.com/withastro/astro/pull/4181) [`77cede720`](https://github.com/withastro/astro/commit/77cede720b09bce34f29c3d2d8b505311ce876b1) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Make collect-headings rehype plugin non-overridable
* [#4174](https://github.com/withastro/astro/pull/4174) [`8eb3a8c6d`](https://github.com/withastro/astro/commit/8eb3a8c6d9554707963c3a3bc36ed8b68d3cf0fb) Thanks [@matthewp](https://github.com/matthewp)! - Allows using React with automatic imports alongside MDX
- [#4145](https://github.com/withastro/astro/pull/4145) [`c7efcf57e`](https://github.com/withastro/astro/commit/c7efcf57e00a0fcde3bc9f813e3cc59902bd484c) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Fix a missing newline bug when `layout` was set.
## 0.6.0
### Minor Changes
- [#4134](https://github.com/withastro/astro/pull/4134) [`2968ba2b6`](https://github.com/withastro/astro/commit/2968ba2b6f00775b6e9872681b390cb466fdbfa2) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Add `headings` and `frontmatter` properties to layout props
## 0.5.0
### Minor Changes
- [#4095](https://github.com/withastro/astro/pull/4095) [`40ef43a59`](https://github.com/withastro/astro/commit/40ef43a59b08a1a8fbcd9f4a53745a9636a4fbb9) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Add IDs to MDX headings and expose via getHeadings() export
* [#4114](https://github.com/withastro/astro/pull/4114) [`64432bcb8`](https://github.com/withastro/astro/commit/64432bcb873efd0e4297c00fc9583a1fe516dfe7) Thanks [@Princesseuh](https://github.com/Princesseuh)! - Refactor `@astrojs/mdx` and `@astrojs/markdown-remark` to use `@astrojs/prism` instead of duplicating the code
### Patch Changes
- [#4112](https://github.com/withastro/astro/pull/4112) [`e33fc9bc4`](https://github.com/withastro/astro/commit/e33fc9bc46ff0a30013deb6dc76e545e70cc3a3e) Thanks [@matthewp](https://github.com/matthewp)! - Fix MDX working with a ts config file
* [#4049](https://github.com/withastro/astro/pull/4049) [`b60cc0538`](https://github.com/withastro/astro/commit/b60cc0538bc5c68dd411117780d20d892530789d) Thanks [@natemoo-re](https://github.com/natemoo-re)! - Improve `injectScript` handling for non-Astro pages
* Updated dependencies [[`64432bcb8`](https://github.com/withastro/astro/commit/64432bcb873efd0e4297c00fc9583a1fe516dfe7)]:
- @astrojs/prism@0.7.0
## 0.4.0
### Minor Changes
- [#4088](https://github.com/withastro/astro/pull/4088) [`1743fe140`](https://github.com/withastro/astro/commit/1743fe140eb58d60e26cbd11a066bb60de046e0c) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Support "layout" frontmatter property
## 0.3.1
### Patch Changes
- [#4076](https://github.com/withastro/astro/pull/4076) [`6120a71e5`](https://github.com/withastro/astro/commit/6120a71e5425ad55a17ddac800d64a3f50273bce) Thanks [@matthewp](https://github.com/matthewp)! - Ensure file and url are always present in MDX for Astro.glob
## 0.3.0
### Minor Changes
- [#3977](https://github.com/withastro/astro/pull/3977) [`19433eb4a`](https://github.com/withastro/astro/commit/19433eb4a4441522f68492ca914ad2ab4f061343) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Add remarkPlugins and rehypePlugins to config, with the same default plugins as our standard Markdown parser
* [#4002](https://github.com/withastro/astro/pull/4002) [`3b8a74452`](https://github.com/withastro/astro/commit/3b8a7445247221100462ba035f6778b43ea180e7) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Support Prism and Shiki syntax highlighting based on project config
- [#3995](https://github.com/withastro/astro/pull/3995) [`b2b367c96`](https://github.com/withastro/astro/commit/b2b367c969493aaf21c974064beb241d05228066) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Support YAML frontmatter in MDX files
### Patch Changes
- [#4050](https://github.com/withastro/astro/pull/4050) [`9ab66c4ba`](https://github.com/withastro/astro/commit/9ab66c4ba9bf2250990114c76b792f26d0694365) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Add support for injected "page-ssr" scripts
* [#3981](https://github.com/withastro/astro/pull/3981) [`61fec6304`](https://github.com/withastro/astro/commit/61fec63044e1585348e8405bee6fdf4dec635efa) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Include page url in MDX glob result
## 0.2.1
### Patch Changes
- [#3937](https://github.com/withastro/astro/pull/3937) [`31f9c0bf0`](https://github.com/withastro/astro/commit/31f9c0bf029ffa4b470e620f2c32e1370643e81e) Thanks [@delucis](https://github.com/delucis)! - Roll back supported Node engines
## 0.2.0
### Minor Changes
- [#3914](https://github.com/withastro/astro/pull/3914) [`b48767985`](https://github.com/withastro/astro/commit/b48767985359bd359df8071324952ea5f2bc0d86) Thanks [@ran-dall](https://github.com/ran-dall)! - Rollback supported `node@16` version. Minimum versions are now `node@14.20.0` or `node@16.14.0`.
## 0.1.1
### Patch Changes
- [#3885](https://github.com/withastro/astro/pull/3885) [`bf5d1cc1e`](https://github.com/withastro/astro/commit/bf5d1cc1e71da38a14658c615e9481f2145cc6e7) Thanks [@delucis](https://github.com/delucis)! - Integration README fixes
## 0.1.0
### Minor Changes
- [#3871](https://github.com/withastro/astro/pull/3871) [`1cc5b7890`](https://github.com/withastro/astro/commit/1cc5b78905633608e5b07ad291f916f54e67feb1) Thanks [@natemoo-re](https://github.com/natemoo-re)! - Update supported `node` versions. Minimum versions are now `node@14.20.0` or `node@16.16.0`.
## 0.0.3
### Patch Changes
- [#3854](https://github.com/withastro/astro/pull/3854) [`b012ee55`](https://github.com/withastro/astro/commit/b012ee55b107dea0730286263b27d83e530fad5d) Thanks [@bholmesdev](https://github.com/bholmesdev)! - [astro add] Support adapters and third party packages
## 0.0.2
### Patch Changes
- [#3706](https://github.com/withastro/astro/pull/3706) [`032ad1c0`](https://github.com/withastro/astro/commit/032ad1c047a62dd663067cc562537d16f2872aa7) Thanks [@natemoo-re](https://github.com/natemoo-re)! - Initial release! 🎉

View file

@ -0,0 +1,302 @@
# @astrojs/markdoc (experimental) 📝
This **[Astro integration][astro-integration]** enables the usage of [Markdoc](https://markdoc.dev/) to create components, pages, and content collection entries.
- <strong>[Why Markdoc?](#why-markdoc)</strong>
- <strong>[Installation](#installation)</strong>
- <strong>[Usage](#usage)</strong>
- <strong>[Configuration](#configuration)</strong>
- <strong>[Examples](#examples)</strong>
- <strong>[Troubleshooting](#troubleshooting)</strong>
- <strong>[Contributing](#contributing)</strong>
- <strong>[Changelog](#changelog)</strong>
## Why Markdoc?
Markdoc allows you to enhance your Markdown with [Astro components][astro-components]. If you have existing content authored in Markdoc, this integration allows you to bring those files to your Astro project using content collections.
## Installation
### Quick Install
The `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one.
```sh
# Using NPM
npx astro add markdoc
# Using Yarn
yarn astro add markdoc
# Using PNPM
pnpm astro add markdoc
```
If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below.
### Manual Install
First, install the `@astrojs/markdoc` package using your package manager. If you're using npm or aren't sure, run this in the terminal:
```sh
npm install @astrojs/markdoc
```
Then, apply this integration to your `astro.config.*` file using the `integrations` property:
__`astro.config.mjs`__
```js ins={2} "markdoc()"
import { defineConfig } from 'astro/config';
import markdoc from '@astrojs/markdoc';
export default defineConfig({
// ...
integrations: [markdoc()],
});
```
### Editor Integration
[VS Code](https://code.visualstudio.com/) supports Markdown by default. However, for Markdoc editor support, you may wish to add the following setting in your VSCode config. This ensures authoring Markdoc files provides a Markdown-like editor experience.
```json title=".vscode/settings.json"
"files.associations": {
"*.mdoc": "markdown"
}
```
## Usage
Markdoc files can only be used within content collections. Add entries to any content collection using the `.mdoc` extension:
```sh
src/content/docs/
why-markdoc.mdoc
quick-start.mdoc
```
Then, query your collection using the [Content Collection APIs](https://docs.astro.build/en/guides/content-collections/#querying-collections):
```astro
---
import { getEntryBySlug } from 'astro:content';
const entry = await getEntryBySlug('docs', 'why-markdoc');
const { Content } = await entry.render();
---
<!--Access frontmatter properties with `data`-->
<h1>{entry.data.title}</h1>
<!--Render Markdoc contents with the Content component-->
<Content />
```
📚 See the [Astro Content Collection docs][astro-content-collections] for more information.
## Configuration
Once the Markdoc integration is installed, no configuration is necessary to use `.mdoc` files in your Content Collections.
### Markdoc config
The Markdoc integration accepts [all Markdoc configuration options](https://markdoc.dev/docs/config), including [tags](https://markdoc.dev/docs/tags) and [variables](https://markdoc.dev/docs/variables).
You can pass these options from the `markdoc()` integration in your `astro.config`. This example declares a `countries` variable and an `includes` function for use across all Markdoc content collection entries:
```js
// astro.config.mjs
import { defineConfig } from 'astro/config';
import markdoc from '@astrojs/markdoc';
// https://astro.build/config
export default defineConfig({
integrations: [
markdoc({
variables: {
// Declare a global list of countries
// Usage in Markdoc: `$countries`
countries: ['EN', 'ES', 'JP'],
},
functions: {
// Check if array includes value
// Usage in Markdoc: `includes(arr, value)`
includes: {
transform(parameters) {
const [array, value] = Object.values(parameters);
return array.includes(value);
},
},
},
}),
],
});
```
:::note
These options will be applied during [the Markdoc "transform" phase](https://markdoc.dev/docs/render#transform). This is run **at build time** (rather than server request time) both for static and SSR Astro projects.
::
📚 [See the Markdoc documentation](https://markdoc.dev/docs/functions#creating-a-custom-function) for more on using variables or functions in your content.
### Content `components` prop
The `Content` component accepts a `components` prop, which defines mappings from Markdoc tags and HTML element names to Astro or UI framework components (React, Vue, Svelte, etc).
#### Render Markdoc nodes / HTML elements as Astro components
You may want to map standard HTML elements like headings and paragraphs to components. For this, you can configure a custom [Markdoc node](https://markdoc.dev/docs/nodes). This example overrides Markdoc's `heading` node to render a `Heading` component, passing the built-in `level` attribute as a prop:
```js
// astro.config.mjs
import { defineConfig } from 'astro/config';
import markdoc from '@astrojs/markdoc';
// https://astro.build/config
export default defineConfig({
integrations: [
markdoc({
nodes: {
heading: {
render: 'Heading',
// Markdoc requires type defs for each attribute.
// These should mirror the `Props` type of the component
// you are rendering.
// See Markdoc's documentation on defining attributes
// https://markdoc.dev/docs/attributes#defining-attributes
attributes: {
level: { type: String },
}
},
},
}),
],
});
```
Now, you can map the string passed to render (`'Heading'` in this example) to a component import. This is configured from the `<Content />` component used to render your Markdoc using the `components` prop:
```astro
---
import { getEntryBySlug } from 'astro:content';
import Heading from '../components/Heading.astro';
const entry = await getEntryBySlug('docs', 'why-markdoc');
const { Content } = await entry.render();
---
<Content
components={{
Heading: Heading,
}}
/>
```
📚 [Find all of Markdoc's built-in nodes and node attributes on their documentation.](https://markdoc.dev/docs/nodes#built-in-nodes)
#### Render Markdoc tags as Astro components
You may also configure [Markdoc tags](https://markdoc.dev/docs/tags) that map to components. You can configure a new tag from your `astro.config` using the `tags` attribute.
```js
// astro.config.mjs
import { defineConfig } from 'astro/config';
import markdoc from '@astrojs/markdoc';
// https://astro.build/config
export default defineConfig({
integrations: [
markdoc({
tags: {
aside: {
render: 'Aside',
attributes: {
// Component props as attribute definitions
// See Markdoc's documentation on defining attributes
// https://markdoc.dev/docs/attributes#defining-attributes
type: { type: String },
}
},
},
}),
],
});
```
Then, you can wire this render name (`'Aside'`) to a component from the `components` prop via the `<Content />` component:
```astro
---
import { getEntryBySlug } from 'astro:content';
import Aside from '../components/Aside.astro';
const entry = await getEntryBySlug('docs', 'why-markdoc');
const { Content } = await entry.render();
---
<Content
components={{
Aside: Aside,
}}
/>
```
#### Use client-side UI components
Today, the `components` prop does not support the `client:` directive for hydrating components. To embed client-side components, create a wrapper `.astro` file to import your component and apply a `client:` directive manually.
This example wraps a `Aside.tsx` component with a `ClientAside.astro` wrapper:
```astro
---
// src/components/ClientAside.astro
import Aside from './Aside';
---
<Aside client:load />
```
This component [can be applied via the `components` prop](#render-html-elements-as-astro-components):
```astro
---
// src/pages/why-markdoc.astro
import { getEntryBySlug } from 'astro:content';
import ClientAside from '../components/ClientAside.astro';
const entry = await getEntryBySlug('docs', 'why-markdoc');
const { Content } = await entry.render();
---
<Content
components={{
aside: ClientAside,
}}
/>
```
## Examples
* The [Astro Markdoc starter template](https://github.com/withastro/astro/tree/latest/examples/with-markdoc) shows how to use Markdoc files in your Astro project.
## Troubleshooting
For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
## Contributing
This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
## Changelog
See [CHANGELOG.md](https://github.com/withastro/astro/tree/main/packages/integrations/markdoc/CHANGELOG.md) for a history of changes to this integration.
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
[astro-components]: https://docs.astro.build/en/core-concepts/astro-components/
[astro-content-collections]: https://docs.astro.build/en/guides/content-collections/

View file

@ -0,0 +1,30 @@
---
import stringifyAttributes from 'stringify-attributes';
import type { AstroNode } from './astroNode';
type Props = {
node: AstroNode;
};
const Node = (Astro.props as Props).node;
---
{
typeof Node === 'string' ? (
<Fragment set:text={Node} />
) : 'component' in Node ? (
<Node.component {...Node.props}>
{Node.children.map((child) => (
<Astro.self node={child} />
))}
</Node.component>
) : (
<Fragment>
<Fragment set:html={`<${Node.tag} ${stringifyAttributes(Node.attributes)}>`} />
{Node.children.map((child) => (
<Astro.self node={child} />
))}
<Fragment set:html={`</${Node.tag}>`} />
</Fragment>
)
}

View file

@ -0,0 +1,15 @@
---
import type { RenderableTreeNode } from '@markdoc/markdoc';
import type { AstroInstance } from 'astro';
import { createAstroNode } from './astroNode';
import RenderNode from './RenderNode.astro';
type Props = {
content: RenderableTreeNode;
components: Record<string, AstroInstance['default']>;
};
const { content, components } = Astro.props as Props;
---
<RenderNode node={createAstroNode(content, components)} />

View file

@ -0,0 +1,86 @@
import type { AstroInstance } from 'astro';
import type { RenderableTreeNode } from '@markdoc/markdoc';
import Markdoc from '@markdoc/markdoc';
import { MarkdocError } from '../dist/utils.js';
import z from 'astro/zod';
export type AstroNode =
| string
| {
component: AstroInstance['default'];
props: Record<string, any>;
children: AstroNode[];
}
| {
tag: string;
attributes: Record<string, any>;
children: AstroNode[];
};
export function createAstroNode(
node: RenderableTreeNode,
components: Record<string, AstroInstance['default']> = {}
): AstroNode {
components = validateComponents(components);
if (typeof node === 'string' || typeof node === 'number') {
return String(node);
} else if (node === null || typeof node !== 'object' || !Markdoc.Tag.isTag(node)) {
return '';
}
if (isCapitalized(node.name) && node.name in components) {
const component = components[node.name];
const props = node.attributes;
const children = node.children.map((child) => createAstroNode(child, components));
return {
component,
props,
children,
};
} else if (isCapitalized(node.name)) {
throw new MarkdocError({
message: `Unable to render ${JSON.stringify(node.name)}.`,
hint: 'Did you add this to the "components" prop on your <Content /> component?',
});
} else {
return {
tag: node.name,
attributes: node.attributes,
children: node.children.map((child) => createAstroNode(child, components)),
};
}
}
function validateComponents(components: Record<string, AstroInstance['default']>) {
try {
return z
.record(
z
.string()
.min(1, 'Invalid `components` prop. Component names cannot be empty!')
.refine(
(value) => isCapitalized(value),
(value) => ({
message: `Invalid \`components\` prop: ${JSON.stringify(
value
)}. Component name must be capitalized. If you want to render HTML elements as components, try using a Markdoc node [TODO: DOCS LINK]`,
})
),
z.any()
)
.parse(components);
} catch (e) {
throw new MarkdocError({
message:
e instanceof z.ZodError
? e.issues[0].message
: 'Invalid `components` prop. Ensure you are passing an object of components to <Content />',
});
}
}
function isCapitalized(str: string) {
return str.length > 0 && str[0] === str[0].toUpperCase();
}

View file

@ -0,0 +1,2 @@
// @ts-expect-error
export { default as Renderer } from './Renderer.astro';

View file

@ -0,0 +1,54 @@
{
"name": "@astrojs/markdoc",
"description": "Use Markdoc within Astro",
"version": "0.0.0",
"type": "module",
"types": "./dist/index.d.ts",
"author": "withastro",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/withastro/astro.git",
"directory": "packages/integrations/markdoc"
},
"keywords": [
"astro-integration",
"astro-component",
"markdoc"
],
"bugs": "https://github.com/withastro/astro/issues",
"homepage": "https://docs.astro.build/en/guides/integrations-guide/markdoc/",
"exports": {
".": "./dist/index.js",
"./components": "./components/index.ts",
"./package.json": "./package.json"
},
"scripts": {
"build": "astro-scripts build \"src/**/*.ts\" && tsc",
"build:ci": "astro-scripts build \"src/**/*.ts\"",
"dev": "astro-scripts dev \"src/**/*.ts\"",
"test": "mocha --exit --timeout 20000",
"test:match": "mocha --timeout 20000 -g"
},
"dependencies": {
"@markdoc/markdoc": "^0.2.2",
"gray-matter": "^4.0.3",
"stringify-attributes": "^3.0.0",
"zod": "^3.17.3"
},
"devDependencies": {
"@types/chai": "^4.3.1",
"@types/html-escaper": "^3.0.0",
"@types/mocha": "^9.1.1",
"astro": "workspace:*",
"astro-scripts": "workspace:*",
"chai": "^4.3.6",
"devalue": "^4.2.0",
"linkedom": "^0.14.12",
"mocha": "^9.2.2",
"vite": "^4.0.3"
},
"engines": {
"node": ">=16.12.0"
}
}

View file

@ -0,0 +1,107 @@
import type { AstroIntegration, AstroConfig } from 'astro';
import { InlineConfig } from 'vite';
import type { Config } from '@markdoc/markdoc';
import Markdoc from '@markdoc/markdoc';
import { prependForwardSlash, getAstroConfigPath, MarkdocError, parseFrontmatter } from './utils.js';
import { fileURLToPath } from 'node:url';
import fs from 'node:fs';
export default function markdoc(markdocConfig: Config = {}): AstroIntegration {
return {
name: '@astrojs/markdoc',
hooks: {
'astro:config:setup': async ({ updateConfig, config, addContentEntryType }: any) => {
function getEntryInfo({ fileUrl, contents }: { fileUrl: URL; contents: string }) {
const parsed = parseFrontmatter(contents, fileURLToPath(fileUrl));
return {
data: parsed.data,
body: parsed.content,
slug: parsed.data.slug,
rawData: parsed.matter,
};
}
const contentEntryType = {
extensions: ['.mdoc'],
getEntryInfo,
contentModuleTypes: await fs.promises.readFile(
new URL('../template/content-module-types.d.ts', import.meta.url),
'utf-8'
),
};
addContentEntryType(contentEntryType);
const viteConfig: InlineConfig = {
plugins: [
{
name: '@astrojs/markdoc',
async transform(code, id) {
if (!id.endsWith('.mdoc')) return;
validateRenderProperties(markdocConfig, config);
const body =
getEntryInfo({ fileUrl: new URL(prependForwardSlash(id), 'file://'), contents: code }).body;
const ast = Markdoc.parse(body);
const content = Markdoc.transform(ast, markdocConfig);
return `import { jsx as h } from 'astro/jsx-runtime';\nimport { Renderer } from '@astrojs/markdoc/components';\nconst transformedContent = ${JSON.stringify(
content
)};\nexport async function Content ({ components }) { return h(Renderer, { content: transformedContent, components }); }\nContent[Symbol.for('astro.needsHeadRendering')] = true;`;
},
},
],
};
updateConfig({ vite: viteConfig });
},
},
};
}
function validateRenderProperties(markdocConfig: Config, astroConfig: AstroConfig) {
const tags = markdocConfig.tags ?? {};
const nodes = markdocConfig.nodes ?? {};
for (const [name, config] of Object.entries(tags)) {
validateRenderProperty({ type: 'tag', name, config, astroConfig });
}
for (const [name, config] of Object.entries(nodes)) {
validateRenderProperty({ type: 'node', name, config, astroConfig });
}
}
function validateRenderProperty({
name,
config,
type,
astroConfig,
}: {
name: string;
config: { render?: string };
type: 'node' | 'tag';
astroConfig: Pick<AstroConfig, 'root'>;
}) {
if (typeof config.render === 'string' && config.render.length === 0) {
throw new Error(
`Invalid ${type} configuration: ${JSON.stringify(
name
)}. The "render" property cannot be an empty string.`
);
}
if (typeof config.render === 'string' && !isCapitalized(config.render)) {
const astroConfigPath = getAstroConfigPath(fs, fileURLToPath(astroConfig.root));
throw new MarkdocError({
message: `Invalid ${type} configuration: ${JSON.stringify(
name
)}. The "render" property must reference a capitalized component name.`,
hint: 'If you want to render to an HTML element, see our docs on rendering Markdoc manually [TODO docs link].',
location: astroConfigPath
? {
file: astroConfigPath,
}
: undefined,
});
}
}
function isCapitalized(str: string) {
return str.length > 0 && str[0] === str[0].toUpperCase();
}

View file

@ -0,0 +1,111 @@
import matter from 'gray-matter';
import path from 'node:path';
import type fsMod from 'node:fs';
import type { ErrorPayload as ViteErrorPayload } from 'vite';
/**
* Match YAML exception handling from Astro core errors
* @see 'astro/src/core/errors.ts'
*/
export function parseFrontmatter(fileContents: string, filePath: string) {
try {
// `matter` is empty string on cache results
// clear cache to prevent this
(matter as any).clearCache();
return matter(fileContents);
} catch (e: any) {
if (e.name === 'YAMLException') {
const err: Error & ViteErrorPayload['err'] = e;
err.id = filePath;
err.loc = { file: e.id, line: e.mark.line + 1, column: e.mark.column };
err.message = e.reason;
throw err;
} else {
throw e;
}
}
}
/**
* Matches AstroError object with types like error codes stubbed out
* @see 'astro/src/core/errors/errors.ts'
*/
export class MarkdocError extends Error {
public errorCode: number;
public loc: ErrorLocation | undefined;
public title: string | undefined;
public hint: string | undefined;
public frame: string | undefined;
type = 'MarkdocError';
constructor(props: ErrorProperties, ...params: any) {
super(...params);
const {
code = 99999,
name,
title = 'MarkdocError',
message,
stack,
location,
hint,
frame,
} = props;
this.errorCode = code;
this.title = title;
if (message) this.message = message;
// Only set this if we actually have a stack passed, otherwise uses Error's
this.stack = stack ? stack : this.stack;
this.loc = location;
this.hint = hint;
this.frame = frame;
}
}
interface ErrorLocation {
file?: string;
line?: number;
column?: number;
}
interface ErrorProperties {
code?: number;
title?: string;
name?: string;
message?: string;
location?: ErrorLocation;
hint?: string;
stack?: string;
frame?: string;
}
/**
* Matches `search` function used for resolving `astro.config` files.
* Used by Markdoc for error handling.
* @see 'astro/src/core/config/config.ts'
*/
export function getAstroConfigPath(fs: typeof fsMod, root: string): string | undefined {
const paths = [
'astro.config.mjs',
'astro.config.js',
'astro.config.ts',
'astro.config.mts',
'astro.config.cjs',
'astro.config.cts',
].map((p) => path.join(root, p));
for (const file of paths) {
if (fs.existsSync(file)) {
return file;
}
}
}
/**
* @see 'astro/src/core/path.ts'
*/
export function prependForwardSlash(str: string) {
return str[0] === '/' ? str : '/' + str;
}

View file

@ -0,0 +1,9 @@
declare module 'astro:content' {
interface Render {
'.mdoc': Promise<{
Content(props: {
components?: Record<string, import('astro').AstroInstance['default']>;
}): import('astro').MarkdownInstance<{}>['Content'];
}>;
}
}

View file

@ -0,0 +1,258 @@
import { parseHTML } from 'linkedom';
import { parse as parseDevalue } from 'devalue';
import { expect } from 'chai';
import { loadFixture, fixLineEndings } from '../../../astro/test/test-utils.js';
import markdoc from '../dist/index.js';
function formatPost(post) {
return {
...post,
body: fixLineEndings(post.body),
};
}
const root = new URL('./fixtures/content-collections/', import.meta.url);
describe('Markdoc - Content Collections', () => {
let baseFixture;
before(async () => {
baseFixture = await loadFixture({
root,
integrations: [markdoc()],
});
});
describe('dev', () => {
let devServer;
before(async () => {
devServer = await baseFixture.startDevServer();
});
after(async () => {
await devServer.stop();
});
it('loads entry', async () => {
const res = await baseFixture.fetch('/entry.json');
const post = parseDevalue(await res.text());
expect(formatPost(post)).to.deep.equal(simplePostEntry);
});
it('loads collection', async () => {
const res = await baseFixture.fetch('/collection.json');
const posts = parseDevalue(await res.text());
expect(posts).to.not.be.null;
expect(posts.sort().map((post) => formatPost(post))).to.deep.equal([
simplePostEntry,
withComponentsEntry,
withConfigEntry,
]);
});
it('renders content - simple', async () => {
const res = await baseFixture.fetch('/content-simple');
const html = await res.text();
const { document } = parseHTML(html);
const h2 = document.querySelector('h2');
expect(h2.textContent).to.equal('Simple post');
const p = document.querySelector('p');
expect(p.textContent).to.equal('This is a simple Markdoc post.');
});
it('renders content - with config', async () => {
const fixture = await getFixtureWithConfig();
const server = await fixture.startDevServer();
const res = await fixture.fetch('/content-with-config');
const html = await res.text();
const { document } = parseHTML(html);
const h2 = document.querySelector('h2');
expect(h2.textContent).to.equal('Post with config');
const textContent = html;
expect(textContent).to.not.include('Hello');
expect(textContent).to.include('Hola');
expect(textContent).to.include(`Konnichiwa`);
await server.stop();
});
it('renders content - with components', async () => {
const fixture = await getFixtureWithComponents();
const server = await fixture.startDevServer();
const res = await fixture.fetch('/content-with-components');
const html = await res.text();
const { document } = parseHTML(html);
const h2 = document.querySelector('h2');
expect(h2.textContent).to.equal('Post with components');
// Renders custom shortcode component
const marquee = document.querySelector('marquee');
expect(marquee).to.not.be.null;
expect(marquee.hasAttribute('data-custom-marquee')).to.equal(true);
// Renders Astro Code component
const pre = document.querySelector('pre');
expect(pre).to.not.be.null;
expect(pre.className).to.equal('astro-code');
await server.stop();
});
});
describe('build', () => {
before(async () => {
await baseFixture.build();
});
it('loads entry', async () => {
const res = await baseFixture.readFile('/entry.json');
const post = parseDevalue(res);
expect(formatPost(post)).to.deep.equal(simplePostEntry);
});
it('loads collection', async () => {
const res = await baseFixture.readFile('/collection.json');
const posts = parseDevalue(res);
expect(posts).to.not.be.null;
expect(posts.sort().map((post) => formatPost(post))).to.deep.equal([
simplePostEntry,
withComponentsEntry,
withConfigEntry,
]);
});
it('renders content - simple', async () => {
const html = await baseFixture.readFile('/content-simple/index.html');
const { document } = parseHTML(html);
const h2 = document.querySelector('h2');
expect(h2.textContent).to.equal('Simple post');
const p = document.querySelector('p');
expect(p.textContent).to.equal('This is a simple Markdoc post.');
});
it('renders content - with config', async () => {
const fixture = await getFixtureWithConfig();
await fixture.build();
const html = await fixture.readFile('/content-with-config/index.html');
const { document } = parseHTML(html);
const h2 = document.querySelector('h2');
expect(h2.textContent).to.equal('Post with config');
const textContent = html;
expect(textContent).to.not.include('Hello');
expect(textContent).to.include('Hola');
expect(textContent).to.include(`Konnichiwa`);
});
it('renders content - with components', async () => {
const fixture = await getFixtureWithComponents();
await fixture.build();
const html = await fixture.readFile('/content-with-components/index.html');
const { document } = parseHTML(html);
const h2 = document.querySelector('h2');
expect(h2.textContent).to.equal('Post with components');
// Renders custom shortcode component
const marquee = document.querySelector('marquee');
expect(marquee).to.not.be.null;
expect(marquee.hasAttribute('data-custom-marquee')).to.equal(true);
// Renders Astro Code component
const pre = document.querySelector('pre');
expect(pre).to.not.be.null;
expect(pre.className).to.equal('astro-code');
});
});
});
function getFixtureWithConfig() {
return loadFixture({
root,
integrations: [
markdoc({
variables: {
countries: ['ES', 'JP'],
},
functions: {
includes: {
transform(parameters) {
const [array, value] = Object.values(parameters);
return Array.isArray(array) ? array.includes(value) : false;
},
},
},
}),
],
});
}
function getFixtureWithComponents() {
return loadFixture({
root,
integrations: [
markdoc({
nodes: {
fence: {
render: 'Code',
attributes: {
language: { type: String },
content: { type: String },
},
},
},
tags: {
mq: {
render: 'CustomMarquee',
attributes: {
direction: {
type: String,
default: 'left',
matches: ['left', 'right', 'up', 'down'],
errorLevel: 'critical',
},
},
},
},
}),
],
});
}
const simplePostEntry = {
id: 'simple.mdoc',
slug: 'simple',
collection: 'blog',
data: {
schemaWorks: true,
title: 'Simple post',
},
body: '\n## Simple post\n\nThis is a simple Markdoc post.\n',
};
const withComponentsEntry = {
id: 'with-components.mdoc',
slug: 'with-components',
collection: 'blog',
data: {
schemaWorks: true,
title: 'Post with components',
},
body: '\n## Post with components\n\nThis uses a custom marquee component with a shortcode:\n\n{% mq direction="right" %}\nI\'m a marquee too!\n{% /mq %}\n\nAnd a code component for code blocks:\n\n```js\nconst isRenderedWithShiki = true;\n```\n',
};
const withConfigEntry = {
id: 'with-config.mdoc',
slug: 'with-config',
collection: 'blog',
data: {
schemaWorks: true,
title: 'Post with config',
},
body: '\n## Post with config\n\n{% if includes($countries, "EN") %} Hello {% /if %}\n{% if includes($countries, "ES") %} Hola {% /if %}\n{% if includes($countries, "JP") %} Konnichiwa {% /if %}\n',
};

View file

@ -0,0 +1,7 @@
import { defineConfig } from 'astro/config';
import markdoc from '@astrojs/markdoc';
// https://astro.build/config
export default defineConfig({
integrations: [markdoc()],
});

View file

@ -0,0 +1,13 @@
{
"name": "@test/markdoc-content-collections",
"version": "0.0.0",
"private": true,
"dependencies": {
"@astrojs/markdoc": "workspace:*",
"@markdoc/markdoc": "^0.2.2",
"astro": "workspace:*"
},
"devDependencies": {
"shiki": "^0.11.1"
}
}

View file

@ -0,0 +1,12 @@
---
import { Code } from 'astro/components';
type Props = {
content: string;
language: string;
}
const { content, language } = Astro.props as Props;
---
<Code lang={language} code={content} />

View file

@ -0,0 +1 @@
<marquee data-custom-marquee {...Astro.props}><slot /></marquee>

View file

@ -0,0 +1,7 @@
---
title: Simple post
---
## Simple post
This is a simple Markdoc post.

View file

@ -0,0 +1,17 @@
---
title: Post with components
---
## Post with components
This uses a custom marquee component with a shortcode:
{% mq direction="right" %}
I'm a marquee too!
{% /mq %}
And a code component for code blocks:
```js
const isRenderedWithShiki = true;
```

View file

@ -0,0 +1,9 @@
---
title: Post with config
---
## Post with config
{% if includes($countries, "EN") %} Hello {% /if %}
{% if includes($countries, "ES") %} Hola {% /if %}
{% if includes($countries, "JP") %} Konnichiwa {% /if %}

View file

@ -0,0 +1,12 @@
import { defineCollection, z } from 'astro:content';
const blog = defineCollection({
schema: z.object({
title: z.string(),
}).transform(data => ({
...data,
schemaWorks: true,
}))
});
export const collections = { blog };

View file

@ -0,0 +1,10 @@
import { getCollection } from 'astro:content';
import { stringify } from 'devalue';
import { stripAllRenderFn } from '../../utils.js';
export async function get() {
const posts = await getCollection('blog');
return {
body: stringify(stripAllRenderFn(posts))
};
}

View file

@ -0,0 +1,18 @@
---
import { getEntryBySlug } from "astro:content";
const post = await getEntryBySlug('blog', 'simple');
const { Content } = await post.render();
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Content - Simple</title>
</head>
<body>
<Content />
</body>
</html>

View file

@ -0,0 +1,23 @@
---
import { getEntryBySlug } from "astro:content";
import Code from '../components/Code.astro';
import CustomMarquee from '../components/CustomMarquee.astro';
const post = await getEntryBySlug('blog', 'with-components');
const { Content } = await post.render();
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Content - with components</title>
</head>
<body>
<Content
components={{ CustomMarquee, Code }}
/>
</body>
</html>

View file

@ -0,0 +1,19 @@
---
import { getEntryBySlug } from "astro:content";
const post = await getEntryBySlug('blog', 'with-config');
const { Content } = await post.render();
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Content - with config</title>
</head>
<body>
<Content />
</body>
</html>

View file

@ -0,0 +1,10 @@
import { getEntryBySlug } from 'astro:content';
import { stringify } from 'devalue';
import { stripRenderFn } from '../../utils.js';
export async function get() {
const post = await getEntryBySlug('blog', 'simple');
return {
body: stringify(stripRenderFn(post)),
};
}

View file

@ -0,0 +1,8 @@
export function stripRenderFn(entryWithRender) {
const { render, ...entry } = entryWithRender;
return entry;
}
export function stripAllRenderFn(collection = []) {
return collection.map(stripRenderFn);
}

View file

@ -0,0 +1,10 @@
{
"extends": "../../../tsconfig.base.json",
"include": ["src"],
"compilerOptions": {
"allowJs": true,
"module": "ES2020",
"outDir": "./dist",
"target": "ES2020"
}
}

View file

@ -6,6 +6,7 @@ import mdxPlugin, { Options as MdxRollupPluginOptions } from '@mdx-js/rollup';
import type { AstroIntegration } from 'astro';
import { parse as parseESM } from 'es-module-lexer';
import fs from 'node:fs/promises';
import { fileURLToPath } from 'node:url';
import type { Options as RemarkRehypeOptions } from 'remark-rehype';
import { VFile } from 'vfile';
import type { Plugin as VitePlugin } from 'vite';
@ -26,8 +27,32 @@ export default function mdx(partialMdxOptions: Partial<MdxOptions> = {}): AstroI
return {
name: '@astrojs/mdx',
hooks: {
'astro:config:setup': async ({ updateConfig, config, addPageExtension, command }: any) => {
'astro:config:setup': async ({
updateConfig,
config,
addPageExtension,
addContentEntryType,
command,
}: any) => {
const contentEntryType = {
extensions: ['.mdx'],
async getEntryInfo({ fileUrl, contents }: { fileUrl: URL; contents: string }) {
const parsed = parseFrontmatter(contents, fileURLToPath(fileUrl));
return {
data: parsed.data,
body: parsed.content,
slug: parsed.data.slug,
rawData: parsed.matter,
};
},
contentModuleTypes: await fs.readFile(
new URL('../template/content-module-types.d.ts', import.meta.url),
'utf-8'
),
};
addPageExtension('.mdx');
addContentEntryType(contentEntryType);
const extendMarkdownConfig =
partialMdxOptions.extendMarkdownConfig ?? defaultOptions.extendMarkdownConfig;

View file

@ -24,6 +24,9 @@ import remarkPrism from './remark-prism.js';
import remarkShiki from './remark-shiki.js';
import { isRelativePath, jsToTreeNode } from './utils.js';
// Skip nonessential plugins during performance benchmark runs
const isPerformanceBenchmark = Boolean(process.env.ASTRO_PERFORMANCE_BENCHMARK);
export function recmaInjectImportMetaEnvPlugin({
importMetaEnv,
}: {
@ -130,25 +133,28 @@ export async function getRemarkPlugins(
): Promise<MdxRollupPluginOptions['remarkPlugins']> {
let remarkPlugins: PluggableList = [];
if (mdxOptions.gfm) {
remarkPlugins.push(remarkGfm);
}
if (mdxOptions.smartypants) {
remarkPlugins.push(remarkSmartypants);
if (!isPerformanceBenchmark) {
if (mdxOptions.gfm) {
remarkPlugins.push(remarkGfm);
}
if (mdxOptions.smartypants) {
remarkPlugins.push(remarkSmartypants);
}
}
remarkPlugins = [...remarkPlugins, ...ignoreStringPlugins(mdxOptions.remarkPlugins)];
// Apply syntax highlighters after user plugins to match `markdown/remark` behavior
if (mdxOptions.syntaxHighlight === 'shiki') {
remarkPlugins.push([await remarkShiki(mdxOptions.shikiConfig)]);
if (!isPerformanceBenchmark) {
// Apply syntax highlighters after user plugins to match `markdown/remark` behavior
if (mdxOptions.syntaxHighlight === 'shiki') {
remarkPlugins.push([await remarkShiki(mdxOptions.shikiConfig)]);
}
if (mdxOptions.syntaxHighlight === 'prism') {
remarkPlugins.push(remarkPrism);
}
// Apply last in case user plugins resolve relative image paths
remarkPlugins.push(toRemarkContentRelImageError(config));
}
if (mdxOptions.syntaxHighlight === 'prism') {
remarkPlugins.push(remarkPrism);
}
// Apply last in case user plugins resolve relative image paths
remarkPlugins.push(toRemarkContentRelImageError(config));
return remarkPlugins;
}
@ -166,8 +172,7 @@ export function getRehypePlugins(mdxOptions: MdxOptions): MdxRollupPluginOptions
...ignoreStringPlugins(mdxOptions.rehypePlugins),
// getHeadings() is guaranteed by TS, so this must be included.
// We run `rehypeHeadingIds` _last_ to respect any custom IDs set by user plugins.
rehypeHeadingIds,
rehypeInjectHeadingsExport,
...(isPerformanceBenchmark ? [] : [rehypeHeadingIds, rehypeInjectHeadingsExport]),
// computed from `astro.data.frontmatter` in VFile data
rehypeApplyFrontmatterExport,
];

Some files were not shown because too many files have changed in this diff Show more