summaryrefslogtreecommitdiff
path: root/examples/remote-markdown/docs/dev.md
diff options
context:
space:
mode:
authorGravatar Nate Moore <natemoo-re@users.noreply.github.com> 2021-05-17 09:29:16 -0500
committerGravatar GitHub <noreply@github.com> 2021-05-17 09:29:16 -0500
commitb3886c206f550b53227facd0480a94500ab2515d (patch)
treeb3a1af99f6fa62adeb6996db1c4d47f4015c32d4 /examples/remote-markdown/docs/dev.md
parentfe5cf78e8e5760f814aa7f5af4c68f51b2ce457c (diff)
downloadastro-b3886c206f550b53227facd0480a94500ab2515d.tar.gz
astro-b3886c206f550b53227facd0480a94500ab2515d.tar.zst
astro-b3886c206f550b53227facd0480a94500ab2515d.zip
Fix markdown issues (#208)
* Init fix/markdown * Astro Markdown (#207) * Add Astro Markdown to VSCode Extension * Add Astro Markdown to Astro * refactor: update astro-markdown example * feat: remove embedded components from `.md` files * fix: resolve `.md.astro` files at runtime * chore: update markdown tests * feat: add <Markdown> component * chore: bump examples * chore: update example * fix: improve Markdown child handling * feat: harden markdown support, add code fence support, add automatic dedenting * chore: add weird markdown edge cases * chore: update remote-markdown examples * chore: add comment to Markdown.astro * feat: improve markdown support (codefences, nested inside HTML) * refactor: extract import specifier types to set * refactor: conditionally import markdown renderer * refactor: revert special-cased "astro/components" * refactor: revert special-cased "astro/components" * refactor: use astro/components/Markdown.astro * refactor: remove `.md.astro` support in favor of Markdown component * refactor: use regular .astro files * refactor: remove unused code * refactor: move Markdown inside Layout * wip: markdown scoped styles * feat: improve scoped styles in Markdown * feat: micromark => remark ecosystem * fix: markdown build * fix: markdown build * chore: add todo * fix: collect headers text * docs: add Markdown doc * chore: add changeset * docs: improve Markdown highlighting * refactor: prefer Set * refactor: exclude large unified deps * docs: update markdown docs Co-authored-by: Jonathan Neal <jonathantneal@hotmail.com> * chore: remove extra markdown deps * perf: optimize markdown * fix: unified/rehype deps * temp: fix markdown test * test: add TODO comment * fix: do not namespace frontmatter, just astro metadata * test: fix astro-markdown test * test: add realworld markdown example * fix: prism language bug * docs: update markdown docs * chore: bump dependencies * fix: escape codespan * fix: unterminated string literal * fix(vscode): inline dependencies * fix(vscode): dependencies * feat(vscode): embedded markdown * feat: add Markdown syntax highlighting * chore: improve markdown example * fix: markdown example * feat: highlighting improvements * chore: add changeset * fix: CodeBlock => CodeSpan * chore: get astro-markdown example running Co-authored-by: Jonathan Neal <jonathantneal@hotmail.com>
Diffstat (limited to 'examples/remote-markdown/docs/dev.md')
-rw-r--r--examples/remote-markdown/docs/dev.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/examples/remote-markdown/docs/dev.md b/examples/remote-markdown/docs/dev.md
new file mode 100644
index 000000000..d9223cbbd
--- /dev/null
+++ b/examples/remote-markdown/docs/dev.md
@@ -0,0 +1,48 @@
+# Development Server
+
+The development server comes as part of the Astro CLI. Start the server with:
+
+```shell
+astro dev
+```
+
+In your project root. You can specify an alternative
+
+## Special routes
+
+The dev server will serve the following special routes:
+
+### /400
+
+This is a custom **400** status code page. You can add this route by adding a page component to your `src/pages` folder:
+
+```
+├── src/
+│ ├── components/
+│ └── pages/
+│ └── 400.astro
+```
+
+For any URL you visit that doesn't have a corresponding page, the `400.astro` file will be used.
+
+### /500
+
+This is a custom **500** status code page. You can add this route by adding a page component to your `src/pages` folder:
+
+```astro
+├── src/ │ ├── components/ │ └── pages/ │ └── 500.astro
+```
+
+This page is used any time an error occurs in the dev server.
+
+The 500 page will receive an `error` query parameter which you can access with:
+
+```
+---
+const error = Astro.request.url.searchParams.get('error');
+---
+
+<strong>{error}</strong>
+```
+
+A default error page is included with Astro so you will get pretty error messages even without adding a custom 500 page.