From 0c0b24a3f59b47f8c69f60c157a8341f36271afa Mon Sep 17 00:00:00 2001 From: Marc RDWZ Date: Tue, 5 Sep 2023 13:05:06 +0200 Subject: [PATCH 1/2] Fix example readmes lang unspecified code blocks --- examples/README.md | 6 +++--- examples/basics/README.md | 4 ++-- examples/blog/README.md | 4 ++-- examples/component/README.md | 4 ++-- examples/deno/README.md | 4 ++-- examples/framework-alpine/README.md | 2 +- examples/framework-lit/README.md | 2 +- examples/framework-multiple/README.md | 2 +- examples/framework-preact/README.md | 2 +- examples/framework-react/README.md | 2 +- examples/framework-solid/README.md | 2 +- examples/framework-svelte/README.md | 2 +- examples/framework-vue/README.md | 2 +- examples/hackernews/README.md | 4 ++-- examples/integration/README.md | 4 ++-- examples/minimal/README.md | 4 ++-- examples/non-html-pages/README.md | 4 ++-- examples/portfolio/README.md | 2 +- examples/with-markdoc/README.md | 4 ++-- examples/with-markdown-plugins/README.md | 2 +- examples/with-markdown-shiki/README.md | 2 +- examples/with-mdx/README.md | 2 +- examples/with-nanostores/README.md | 2 +- examples/with-tailwindcss/README.md | 2 +- examples/with-vite-plugin-pwa/README.md | 4 ++-- examples/with-vitest/README.md | 2 +- 26 files changed, 38 insertions(+), 38 deletions(-) diff --git a/examples/README.md b/examples/README.md index ab0e5a6c0791..1482084d42df 100644 --- a/examples/README.md +++ b/examples/README.md @@ -2,7 +2,7 @@ The easiest way to check out one of these examples on your machine is by running this command in an empty directory: -``` +```sh npm create astro@latest -- --template [EXAMPLE_NAME] ``` @@ -10,12 +10,12 @@ npm create astro@latest -- --template [EXAMPLE_NAME] Visit [awesome-astro](https://github.com/one-aalam/awesome-astro) for a full list of community examples. You can use `npm create astro@latest` to check out any community examples: -``` +```sh npm create astro@latest -- --template [GITHUB_USER]/[REPO_NAME] ``` Paths to examples nested inside of a repo are also supported: -``` +```sh npm create astro@latest -- --template [GITHUB_USER]/[REPO_NAME]/path/to/example ``` diff --git a/examples/basics/README.md b/examples/basics/README.md index 5369073b906d..1db3fb3991a8 100644 --- a/examples/basics/README.md +++ b/examples/basics/README.md @@ -1,6 +1,6 @@ # Astro Starter Kit: Basics -``` +```sh npm create astro@latest -- --template basics ``` @@ -16,7 +16,7 @@ npm create astro@latest -- --template basics Inside of your Astro project, you'll see the following folders and files: -``` +```text / ├── public/ │ └── favicon.svg diff --git a/examples/blog/README.md b/examples/blog/README.md index 67d0cfc2ee8b..758716e07c57 100644 --- a/examples/blog/README.md +++ b/examples/blog/README.md @@ -1,6 +1,6 @@ # Astro Starter Kit: Blog -``` +```sh npm create astro@latest -- --template blog ``` @@ -25,7 +25,7 @@ Features: Inside of your Astro project, you'll see the following folders and files: -``` +```text ├── public/ ├── src/ │   ├── components/ diff --git a/examples/component/README.md b/examples/component/README.md index c92a01a954f4..f51958529925 100644 --- a/examples/component/README.md +++ b/examples/component/README.md @@ -2,7 +2,7 @@ This is a template for an Astro component library. Use this template for writing components to use in multiple projects or publish to NPM. -``` +```sh npm create astro@latest -- --template component ``` @@ -14,7 +14,7 @@ npm create astro@latest -- --template component Inside of your Astro project, you'll see the following folders and files: -``` +```text / ├── index.ts ├── src diff --git a/examples/deno/README.md b/examples/deno/README.md index af49ebcb7e30..17deeb3b9d9e 100644 --- a/examples/deno/README.md +++ b/examples/deno/README.md @@ -4,7 +4,7 @@ [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/deno) [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/deno/devcontainer.json) -``` +```sh npm create astro@latest -- --template deno ``` @@ -16,7 +16,7 @@ npm create astro@latest -- --template deno Inside of your Astro project, you'll see the following folders and files: -``` +```text / ├── public/ │ └── favicon.svg diff --git a/examples/framework-alpine/README.md b/examples/framework-alpine/README.md index 9c61ea1b0f81..22cc7537430b 100644 --- a/examples/framework-alpine/README.md +++ b/examples/framework-alpine/README.md @@ -1,6 +1,6 @@ # Astro + AlpineJS Example -``` +```sh npm create astro@latest -- --template framework-alpine ``` diff --git a/examples/framework-lit/README.md b/examples/framework-lit/README.md index 9afdb987cb03..714d179da2c3 100644 --- a/examples/framework-lit/README.md +++ b/examples/framework-lit/README.md @@ -1,6 +1,6 @@ # Astro + Lit Example -``` +```sh npm create astro@latest -- --template framework-lit ``` diff --git a/examples/framework-multiple/README.md b/examples/framework-multiple/README.md index 385b0ade7872..30b020effb0c 100644 --- a/examples/framework-multiple/README.md +++ b/examples/framework-multiple/README.md @@ -1,6 +1,6 @@ # Kitchen Sink: Microfrontends with Astro -``` +```sh npm create astro@latest -- --template framework-multiple ``` diff --git a/examples/framework-preact/README.md b/examples/framework-preact/README.md index 8bebec195aa3..04efb2d6ea98 100644 --- a/examples/framework-preact/README.md +++ b/examples/framework-preact/README.md @@ -1,6 +1,6 @@ # Astro + Preact Example -``` +```sh npm create astro@latest -- --template framework-preact ``` diff --git a/examples/framework-react/README.md b/examples/framework-react/README.md index 57afd632aaa1..f036afa8c6a8 100644 --- a/examples/framework-react/README.md +++ b/examples/framework-react/README.md @@ -1,6 +1,6 @@ # Astro + React Example -``` +```sh npm create astro@latest -- --template framework-react ``` diff --git a/examples/framework-solid/README.md b/examples/framework-solid/README.md index f95f8d8f5bc0..2943a7692b11 100644 --- a/examples/framework-solid/README.md +++ b/examples/framework-solid/README.md @@ -1,6 +1,6 @@ # Astro + Solid.js Example -``` +```sh npm create astro@latest -- --template framework-solid ``` diff --git a/examples/framework-svelte/README.md b/examples/framework-svelte/README.md index abf0679cc684..5c5a24cc05b6 100644 --- a/examples/framework-svelte/README.md +++ b/examples/framework-svelte/README.md @@ -1,6 +1,6 @@ # Astro + Svelte Example -``` +```sh npm create astro@latest -- --template framework-svelte ``` diff --git a/examples/framework-vue/README.md b/examples/framework-vue/README.md index 07f94e1c3f54..14e778765a5b 100644 --- a/examples/framework-vue/README.md +++ b/examples/framework-vue/README.md @@ -1,6 +1,6 @@ # Astro + Vue Example -``` +```sh npm create astro@latest -- --template framework-vue ``` diff --git a/examples/hackernews/README.md b/examples/hackernews/README.md index 042a7807b51f..55c657dc91ac 100644 --- a/examples/hackernews/README.md +++ b/examples/hackernews/README.md @@ -1,6 +1,6 @@ # Astro Starter Kit: Hackernews -``` +```sh npm create astro@latest -- --template hackernews ``` @@ -14,7 +14,7 @@ npm create astro@latest -- --template hackernews Inside of your Astro project, you'll see the following folders and files: -``` +```text / ├── public/ │ └── favicon.svg diff --git a/examples/integration/README.md b/examples/integration/README.md index a6709d4004de..4f0880031250 100644 --- a/examples/integration/README.md +++ b/examples/integration/README.md @@ -2,7 +2,7 @@ This is a template for an Astro integration. Use this template for writing integrations to use in multiple projects or publish to NPM. -``` +```sh npm create astro@latest -- --template integration ``` @@ -14,7 +14,7 @@ npm create astro@latest -- --template integration Inside of your Astro project, you'll see the following folders and files: -``` +```text / ├── index.ts ├── tsconfig.json diff --git a/examples/minimal/README.md b/examples/minimal/README.md index 20bad66154ec..e34a99b446b4 100644 --- a/examples/minimal/README.md +++ b/examples/minimal/README.md @@ -1,6 +1,6 @@ # Astro Starter Kit: Minimal -``` +```sh npm create astro@latest -- --template minimal ``` @@ -14,7 +14,7 @@ npm create astro@latest -- --template minimal Inside of your Astro project, you'll see the following folders and files: -``` +```text / ├── public/ ├── src/ diff --git a/examples/non-html-pages/README.md b/examples/non-html-pages/README.md index ecdee84b10dc..c26b016982dc 100644 --- a/examples/non-html-pages/README.md +++ b/examples/non-html-pages/README.md @@ -4,7 +4,7 @@ Documentation for "Non-HTML Pages": https://docs.astro.build/en/core-concepts/endpoints/#static-file-endpoints -``` +```sh npm create astro@latest -- --template non-html-pages ``` @@ -18,7 +18,7 @@ npm create astro@latest -- --template non-html-pages Inside of your Astro project, you'll see the following folders and files: -``` +```text / ├── public/ ├── src/ diff --git a/examples/portfolio/README.md b/examples/portfolio/README.md index 3c8ee3aa4725..312d18b1cf5d 100644 --- a/examples/portfolio/README.md +++ b/examples/portfolio/README.md @@ -1,6 +1,6 @@ # Astro Starter Kit: Portfolio -``` +```sh npm create astro@latest -- --template portfolio ``` diff --git a/examples/with-markdoc/README.md b/examples/with-markdoc/README.md index 1a1acc1a5f39..35afb0f3f196 100644 --- a/examples/with-markdoc/README.md +++ b/examples/with-markdoc/README.md @@ -2,7 +2,7 @@ This starter showcases the experimental Markdoc integration. -``` +```sh npm create astro@latest -- --template with-markdoc ``` @@ -15,7 +15,7 @@ npm create astro@latest -- --template with-markdoc Inside of your Astro project, you'll see the following folders and files: -``` +```text / ├── public/ ├── src/ diff --git a/examples/with-markdown-plugins/README.md b/examples/with-markdown-plugins/README.md index 7f955f6c4091..91811541a7e8 100644 --- a/examples/with-markdown-plugins/README.md +++ b/examples/with-markdown-plugins/README.md @@ -1,6 +1,6 @@ # Astro Example: Markdown with Plugins -``` +```sh npm create astro@latest -- --template with-markdown-plugins ``` diff --git a/examples/with-markdown-shiki/README.md b/examples/with-markdown-shiki/README.md index 7a26a9e9b5d7..72251f6ba4bc 100644 --- a/examples/with-markdown-shiki/README.md +++ b/examples/with-markdown-shiki/README.md @@ -1,6 +1,6 @@ # Astro Example: Markdown with Shiki -``` +```sh npm create astro@latest -- --template with-markdown-shiki ``` diff --git a/examples/with-mdx/README.md b/examples/with-mdx/README.md index 8f6780443db2..55fe589cf0b7 100644 --- a/examples/with-mdx/README.md +++ b/examples/with-mdx/README.md @@ -1,6 +1,6 @@ # Astro Example: MDX -``` +```sh npm create astro@latest -- --template with-mdx ``` diff --git a/examples/with-nanostores/README.md b/examples/with-nanostores/README.md index 7771a9a6aed7..163c9129a1c1 100644 --- a/examples/with-nanostores/README.md +++ b/examples/with-nanostores/README.md @@ -1,6 +1,6 @@ # Astro Example: Nanostores -``` +```sh npm create astro@latest -- --template with-nanostores ``` diff --git a/examples/with-tailwindcss/README.md b/examples/with-tailwindcss/README.md index 54dbc84be0a5..8b512bb7fdc6 100644 --- a/examples/with-tailwindcss/README.md +++ b/examples/with-tailwindcss/README.md @@ -1,6 +1,6 @@ # Astro with Tailwind -``` +```sh npm create astro@latest -- --template with-tailwindcss ``` diff --git a/examples/with-vite-plugin-pwa/README.md b/examples/with-vite-plugin-pwa/README.md index 555d3e7de755..3cc99dbc93f8 100644 --- a/examples/with-vite-plugin-pwa/README.md +++ b/examples/with-vite-plugin-pwa/README.md @@ -1,6 +1,6 @@ # Astro Starter Kit: Vite PWA -``` +```sh npm create astro@latest -- --template with-vite-plugin-pwa ``` @@ -14,7 +14,7 @@ npm create astro@latest -- --template with-vite-plugin-pwa Inside of your Astro project, you'll see the following folders and files: -``` +```text / ├── public/ ├── src/ diff --git a/examples/with-vitest/README.md b/examples/with-vitest/README.md index 5187424e00a9..8b831d88c011 100644 --- a/examples/with-vitest/README.md +++ b/examples/with-vitest/README.md @@ -1,6 +1,6 @@ # Astro + [Vitest](https://vitest.dev/) Example -``` +```sh npm create astro@latest -- --template with-vitest ``` From 00731da4c74eb1e1df18a74b6fdb2108cddd6b34 Mon Sep 17 00:00:00 2001 From: Marc RDWZ Date: Tue, 5 Sep 2023 13:05:06 +0200 Subject: [PATCH 2/2] Fix example readmes lang unspecified code blocks --- .changeset/poor-pears-wash.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/poor-pears-wash.md diff --git a/.changeset/poor-pears-wash.md b/.changeset/poor-pears-wash.md new file mode 100644 index 000000000000..5a7117e93fe3 --- /dev/null +++ b/.changeset/poor-pears-wash.md @@ -0,0 +1,5 @@ +--- +'astro': patch +--- + +Fix lang unspecified code blocks (markdownlint MD040)