Yan Thomas
e33d951af1
Remove draft pages info from mdx integration guide ( #8281 )
2023-08-30 07:25:29 -04:00
Hippo
bc9ce779d3
Move code block titles into comments to match docs ( #7543 )
...
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
2023-07-01 16:34:49 +02:00
Bjorn Lu
8e3cb20b5c
Format markdown files ( #7439 )
...
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2023-06-26 11:34:13 +08:00
Bjorn Lu
ea16570b1e
Add MDX optimize option ( #7151 )
...
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2023-05-25 19:43:29 +08:00
Chris Swithinbank
c6cf847bd0
Revert MDX README changes ( #6062 )
2023-01-31 15:41:22 +01:00
Subha Chanda
1c7eef308e
Updated according to new configuration ( #5478 )
...
* Updated according to new configuration
Astro imports the `defineConfig` function from `astro/config`. The `integrations` key needs to be passed into the `defineConfig` function, but it is not shown in the README. Updated the README according to the CLI example.
* update alpine
* update image
* update lit
* update mdx
* update preact
* update prefetch
* update react
* update sitemap
* update solid
* update svelte
* update tailwind
* update turbolinks
* update vue
* chore: add changeset
* update image
* update svelte readme
Co-authored-by: Nate Moore <nate@astro.build>
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
2023-01-26 13:03:00 -06:00
Sarah Rainsberger
03e374f6bc
[docs] typo fix in MDX README ( #5977 )
2023-01-25 10:46:58 -04:00
Chris Swithinbank
000d3e6940
Fix docs links in MDX README ( #5741 )
2023-01-04 11:46:05 +01:00
Ben Holmes
a9c2920264
Markdown and MDX configuration rework ( #5684 )
...
* feat: change extendDefaults -> gfm
* deps: remove smartypants from md/remark
* tests: update markdown plugin tests
* fix: borked lockfile
* feat: allow all Markdown options in MDX config, with extend
* deps: remove smartypants from MDX
* chore: remove unused `mode` property
* chore: remark rehype types
* chore: dead code
* fix: order of default config properties
* refactor: move md defaults to remark
* fix: RemarkRehype type
* fix: apply defaults based on MD defaults
* chore: update plugin tests
* chore: add syntaxHighlight test
* refactor: remove drafts from config defaults
* docs: new MDX config options
* chore: add changeset
* edit: test both extends for syntax highlight
* refactor: remove MDX config deep merge
* docs: update README and changeset
* edit: avoid -> disable
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
* edit: `drafts` clarification
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
* edit: remove "scare quotes"
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
* docs: MDX config options redraft
* docs: add migration
* chore: changeset heading levels
* refactor: githubFlavoredMarkdown -> gfm
* chore: remove unused imports
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2023-01-03 17:12:47 -05:00
Chris Swithinbank
f4ff69a3cd
Fix link in MDX integration README ( #5586 )
2022-12-12 14:14:24 +01:00
Sarah Rainsberger
3f811eb682
[docs] MDX README update ( #5570 )
...
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2022-12-09 12:45:47 -04:00
Thomas Jaggi
2a1c085b19
[MDX] Support remark-rehype options from Astro Markdown config ( #5427 )
...
* [MDX] Support remark-rehype options from Astro Markdown config
* [MDX] Add remarkRehype to MdxOptions, extend with default markdown config
* [MDX] Add remarkRehype to README
* [MDX] Fix remarkRehype inheritance, add tests
* [MDX] Update remarkRehype docs in README
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
* [MDX] Fix remarkRehype docs
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-11-22 10:12:25 -05:00
Chris Swithinbank
ef2ffc7ae9
Fix docs link in MDX integration README ( #5448 )
2022-11-21 12:15:05 +01:00
Dan Jutan
6e417a9636
Fix broken fragment link ( #5200 )
2022-10-27 15:58:54 +08:00
Christian Fuss
e86723d931
[MDX] Improved docs for custom components ( #5190 )
...
* [MDX] Fixed minor formatting issues in README
- whitespace at line end
- blank lines around lists and code fences
- casing of internal references
* Detailed use of custom component with imported MDX
Incorporated all review comments from Sarah and Ben manually,
because the old branch would not pass the mergeability check.
2022-10-25 16:54:47 -04:00
Ben Holmes
308e565ad3
[MDX] Support recmaPlugins config ( #5146 )
...
* feat: support recma plugins
* chore: add `test:match` to MDX
* chore: changeset
* docs: add recmaPlugins to README
2022-10-24 14:27:37 -04:00
Georgey
61f7e16491
Update README.md ( #5179 )
...
Hey there, so recently I was playing around the mdx, and wanted my users to navigate to a specific section in my article using the `id` tags. This was not happening when I was making custom components. When I pass the Astro props like above, the id was automatically getting passed for headings.
2022-10-24 14:22:34 -04:00
Jake Strawn
b0f6216367
docs: Update references to support channel in Discord. ( #4872 )
2022-09-26 21:02:05 +08:00
Ben Holmes
e5f71142eb
docs: add MDXLayoutProps to README ( #4700 )
...
* docs: add MDXLayoutProps to README
* chore: changeset
* nit: remove "if you understand this diff"
* nit: AdD tYpE sAfEtY
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
* Update packages/integrations/mdx/README.md
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
Co-authored-by: Matthew Phillips <matthew@skypack.dev>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-09-22 14:35:37 -04:00
Aditya Jain
620f1d9e1e
fixed broken emoji for in "Getting started" section of integration docs ( #4795 )
...
* fixed broken emoji for "nest frameworks together"
* Add missing whitespace
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
2022-09-19 12:58:06 -03:00
Lloyd Atkinson
eb4f6faee6
docs: add section on .mdx file support in VS Code ( #4694 )
...
* docs: add section on .mdx file support in VS Code
* Update packages/integrations/mdx/README.md
Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
Co-authored-by: Matthew Phillips <matthew@matthewphillips.info>
Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
Co-authored-by: Matthew Phillips <matthew@skypack.dev>
2022-09-09 13:13:09 -04:00
Ben Holmes
c706d845eb
No 👏 more 👏 server 👏 restarts 👏 on 👏 config 👏 changes ( #4578 )
...
* feat: restart config on add, remove, update
* fix: reload for root project configs only
* fix: throw when userConfigPath can't resolve
* chore: changeset
* wip: remove normalizePath before writeFile
* refactor: invalidateWithCache -> isConfigReload
* wip: mustExist?
* debug: config loaded successfully
* debug: more logs
* debug: MORE logging
* fix: normalize resolved config path
* debug: yet MORE logging
* chore: bump proload
* fix: use file path, not URL.pathname
* Revert "wip: mustExist?"
This reverts commit 8ca8662132532dcdc9fd120868e615ddc60f498e.
* chore: remove console log
* feat: cleanup restart message, better invalid config handling
* chore: update lockfile
* chore: fix types
* fix: throw helpful error when config does not exist
* docs: remove "restart dev server" from integrations
* docs: make sure to restart -> try restarting
Co-authored-by: Nate Moore <nate@astro.build>
2022-09-09 11:58:16 -04:00
Tibor Schiemann
d693e365ca
Integrations: Fix NPM instructions to use npx astro add again ( #4653 )
...
* Fix install instructions to use `npx astro` again
* Replace joyful hiccups with regular issues :)
2022-09-07 12:08:58 +02:00
Ben Holmes
8f8dff4d33
[MDX] Extend Markdown plugin config, with customization options ( #4504 )
...
* test: new combined remark / rehype suite
* fix: use with-plugins fixture
* chore: remove old mdx plugin tests
* docs: add JS docs
* docs: update README with thorough example
* chore: changeset
* fix: add "extends" error message
* fix: ignore string-based plugins in md
* feat: add warning log for string plugins
* docs: highlight `extendPlugins`
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
* nit: highlight "extendPlugins"
* fix: md plugins type check
* chore: "defaults" -> "astroDefaults"
* nit: info log when inheriting markdown plugins
* refactor: one big log on new behavior
* dan: dan nit
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-08-30 13:38:35 -04:00
Kyle F Butts
8504cd79b7
Add custom components to mdx integration guide ( #4530 )
...
* Add custom components to mdx integration guide
* Update packages/integrations/mdx/README.md
Co-authored-by: Ben Holmes <hey@bholmes.dev>
* Update packages/integrations/mdx/README.md
Co-authored-by: Ben Holmes <hey@bholmes.dev>
* Update packages/integrations/mdx/README.md
Co-authored-by: Ben Holmes <hey@bholmes.dev>
* Update packages/integrations/mdx/README.md
Co-authored-by: Ben Holmes <hey@bholmes.dev>
* Incorporate Sarah and Ben's Feedback
* Fix what would be an ugly background lol
* Sarah taking liberty of removing double text
* Add changeset
Co-authored-by: Ben Holmes <hey@bholmes.dev>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-08-30 11:55:52 -04:00
Chris Swithinbank
e2b3f8a3f4
integrations: update recommended method for running astro add ( #4340 )
2022-08-16 10:31:14 +02:00
Ben Holmes
f1a52c18af
[MDX] Switch from Shiki Twoslash -> Astro Markdown highlighter ( #4292 )
...
* freat: twoslash -> Astro shiki parser
* test: update shiki style check
* feat: always apply rehypeRaw
* deps: move remark-shiki-twoslash to dev
* test: add shiki-twoslash test
* docs: update readme with twoslash example
* chore: changeset
* nit: remove "describe('disabled')"
2022-08-15 10:43:12 -04:00
Ben Holmes
9d5ab55086
[MDX] Astro.props.content -> frontmatter ( #4237 )
...
* docs: MDX Astro.props.content -> frontmatter
* chore: changeset
2022-08-10 15:43:35 -04:00
Sarah Rainsberger
63d43e1754
remove errant remaining details tags ( #4212 )
2022-08-09 09:09:16 -05:00
Ben Holmes
4c2ca5352d
[MDX] Remove frontmatterOptions ( #4204 )
...
* feat: remove frontmatterOptions config
* test: remove custom frontmatter suite
* deps: remove remark-mdx-frontmatter
* docs: remove `frontmatterOptions` config
* chore: changeset
2022-08-08 17:33:35 -05:00
Ben Holmes
6c9736cbc9
[MDX] Add frontmatter injection to README ( #4205 )
...
* docs: remove `remark-mdx-frontmatter` from README
* docs: remove remark-mdx-frontmatter link
* docs: MDX frontmatter injection
* chore: changeset
2022-08-08 17:16:06 -04:00
Sarah Rainsberger
9894b3dcde
remove details tags from integration READMEs ( #4198 )
2022-08-08 12:07:38 -05:00
Ben Holmes
77cede720b
[MDX] Prevent overriding collect-headings plugin ( #4181 )
...
* fix: make rehypeCollectHeadings a required plugin
* docs: update README on rehypePlugins
* test: remove collect-headings override test
* docs: remove extends from rehype docs
* chore: changeset
2022-08-05 20:51:38 -07:00
Ben Holmes
40ef43a59b
[MDX] Add getHeadings + generate anchor links ( #4095 )
...
* deps: mdx github-slugger
* feat: add getHeadings via rehype plugin
* chore: stray console.log
* test: getHeadings w/ & w/0 JSX expressions
* docs: add generated exports
* refactor: pass headings using vfile.data
* deps: vfile
* test: heading anchor IDs
* docs: add collect-headings to default rehype plugins
* chore: changeset
* deps: estree-util-value-to-estree
* refactor: inject getHeadings export the right way!
* deps: switch to acorn
* refactor: just use acorn
* docs: `getHeadings` info structuring
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
* docs: clarify `url` example
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
* fix: move slugger inside plugin call
* refactor: cleanup code reassignment
* chore: lint
* deps: mdast-util-mdx, test utils
* refactor: add jsToTreeNode util
* feat: expose utils for lib authors
* test: rehype plugins w/ and w/o extends
* test: fixture
* refactor: remove utils from package exports
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2022-08-01 17:23:56 -04:00
Ben Holmes
1743fe140e
feat: support layout in MDX frontmatter ( #4088 )
...
* deps: add gray-matter
* feat: support layout frontmatter property
* test: frontmatter, content prop
* docs: update layout recommendation
* deps: fix lockfile
* chore: changeset
* fix: inherit rollup plugin transform
* fix: avoid parsing frontmatter on custom parsers
* fix: match YAML err handling from md
* docs: absolute url to docs
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
* chore: formatting
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-07-29 11:22:57 -04:00
Sarah Rainsberger
6fb95dbdd6
[docs content] MDX layouts ( #4077 )
2022-07-28 10:06:23 -03:00
Ben Holmes
3b8a744524
[MDX] Add Prism and Shiki support ( #4002 )
...
* deps: add rehype-prism, shiki, rehype-pretty-code
* wip: apply rehype plugins depending on config
* wip: cherry-pick jsx-runtime fix?
* deps: rehype-pretty-code -> shiki-twoslash, add rehype-raw
* wip: add jsx-runtime fix
* feat: get shiki working!
* deps: add @astrojs/prism, prismjs, unist-util-visit
* feat: add prism support
* example: add small syntax highlight demo to with-mdx
* deps: remove rehype-prism
* chore: remove unused async
* chore: add .test.js to all mdx tests
* test: shiki, shikiConfig, prism
* fix: remove "is:raw" from prism output
* docs: add syntax highlighting section
* chore: add changeset
* nit: "Shiki config" -> Shiki config
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
* Revert "wip: add jsx-runtime fix"
This reverts commit 07f4528f44
2022-07-21 16:43:58 -04:00
Ben Holmes
b2b367c969
[MDX] Support YAML frontmatter ( #3995 )
...
* chore: remove old comment
* deps: add remark-frontmatter
* deps: add remark-mdx-frontmatter
* fix: handle null or undefined frontmatter key
* feat: configure frontmatter plugins with defaults
* test: frontmatter and custom frontmatter name
* docs: add frontmatterOptions config
* docs: add "variables" and "frontmatter" docs
* chore: excessible -> accessible
* chore: changeset
* chore: remove bad mdx comment
2022-07-20 21:34:21 -04:00
Ben Holmes
19433eb4a4
[MDX] Support remark and rehype plugins, with defaults ( #3977 )
...
* feaet: allow remark and rehype plugin config
* deps: add remark-gfm, remark-smartypants
* feat: add gfm and smartypants by default
* test: add GFM and remark plugin tests
* feat: preserve default plugins with "extends"
* docs: add remarkPlugins
* docs: add rehypePlugins
* chore: changeset
* fix: remove skip from mdx tests
* chore: dup hyperlink flavor text
* chore: authGen -> autoGen
* nit: markdown -> Markdown
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
* nit: markdown -> Markdown 1
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
* nit: markdown -> Markdown 2
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
* nit: markdown -> Markdown 3
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
* nit: markdown -> Markdown 4
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
2022-07-20 14:14:23 -04:00
Chris Swithinbank
bf5d1cc1e7
More integration README fixes ( #3885 )
...
* Integration README fixes
* More tweaks (mostly code backticks for filenames)
* Update changeset
* Few more tweaks
* Make sure code blocks all have a code language
* Use URLs of new docs pages for package homepage
* One more stray `<br>` 👢
* Standardise to `sh` instead of `shell`
2022-07-11 21:10:34 +02:00
Nate Moore
032ad1c047
MDX support ( #3706 )
...
* feat: first pass at MDX support
* fix: move built-in JSX renderer to come first
* chore: remove jsx example
* chore: update lockfile
* chore: cleanup example
* fix: missing deps
* refactor: move component render logic to `renderPage`
* chore: update HMR script
* chore: update MDX example
* refactor: prefer unshit
* refactor: remove TODO comment
* fix: remove duplicate identifier
* refactor: cleanup mdx entrypoint
* fix: better html handling
* fix: add tsconfig to mdx package
* chore: update lockfile
* fix: do not sort plugins unless mdx is enabled
* chore: update compiler
* fix(hmr): maybe render head for non-Astro pages
* fix: set initial pageExtensions
* refactor: cleanup addPageExtension
* refactor: remove addPageExtensions from types
* refactor: expose HookParameters type
* fix: only default to astro for MDX
* test: pick up jsx support in test fixtures
* refactor: simplify mdx entrypoint
* test: add basic MDX tests
* test(e2e): add mdx + framework tests
* chore: update lockfile
* test(e2e): fix preact mdx e2e test
* fix(mdx): disable .md support
* test(e2e): fix vue-component test missing mdx
* test(e2e): fix solid component needing import
* fix: allow `client:only="solid"` as an alias to `solid-js`
* chore: move to with-mdx example
* chore: update MDX readme
* chore: update example readme
* chore: bump astro version
* chore: update lockfile
* Update mod.d.ts
* feat: support `export const components` in MDX pages
* chore: update mdx example
* fix: update jsx-runtime with better slot support
* refactor: remove object style support
* chore: cleanup package exports
* chore: add todo comment
* refactor: improve isPage function, move to utils
* refactor: dry up manual HMR updates
* chore: add dev tests for MDX
* chore: prefer set to array
* chore: add changesets
* fix(hmr): flip public/private route
Co-authored-by: Nate Moore <nate@astro.build>
2022-06-30 13:09:09 -05:00
