Skip to content

Commit

Permalink
Fix: lang unspecified code blocks (#8461)
Browse files Browse the repository at this point in the history
  • Loading branch information
rdwz authored Sep 11, 2023
1 parent 0a2567c commit 435b105
Show file tree
Hide file tree
Showing 27 changed files with 43 additions and 38 deletions.
5 changes: 5 additions & 0 deletions .changeset/poor-pears-wash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Fix lang unspecified code blocks (markdownlint MD040)
6 changes: 3 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

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]
```

## Community Examples

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
```
4 changes: 2 additions & 2 deletions examples/basics/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Starter Kit: Basics

```
```sh
npm create astro@latest -- --template basics
```

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/blog/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Starter Kit: Blog

```
```sh
npm create astro@latest -- --template blog
```

Expand All @@ -25,7 +25,7 @@ Features:

Inside of your Astro project, you'll see the following folders and files:

```
```text
├── public/
├── src/
│   ├── components/
Expand Down
4 changes: 2 additions & 2 deletions examples/component/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/deno/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/framework-alpine/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro + AlpineJS Example

```
```sh
npm create astro@latest -- --template framework-alpine
```

Expand Down
2 changes: 1 addition & 1 deletion examples/framework-lit/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro + Lit Example

```
```sh
npm create astro@latest -- --template framework-lit
```

Expand Down
2 changes: 1 addition & 1 deletion examples/framework-multiple/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Kitchen Sink: Microfrontends with Astro

```
```sh
npm create astro@latest -- --template framework-multiple
```

Expand Down
2 changes: 1 addition & 1 deletion examples/framework-preact/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro + Preact Example

```
```sh
npm create astro@latest -- --template framework-preact
```

Expand Down
2 changes: 1 addition & 1 deletion examples/framework-react/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro + React Example

```
```sh
npm create astro@latest -- --template framework-react
```

Expand Down
2 changes: 1 addition & 1 deletion examples/framework-solid/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro + Solid.js Example

```
```sh
npm create astro@latest -- --template framework-solid
```

Expand Down
2 changes: 1 addition & 1 deletion examples/framework-svelte/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro + Svelte Example

```
```sh
npm create astro@latest -- --template framework-svelte
```

Expand Down
2 changes: 1 addition & 1 deletion examples/framework-vue/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro + Vue Example

```
```sh
npm create astro@latest -- --template framework-vue
```

Expand Down
4 changes: 2 additions & 2 deletions examples/hackernews/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Starter Kit: Hackernews

```
```sh
npm create astro@latest -- --template hackernews
```

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/minimal/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Starter Kit: Minimal

```
```sh
npm create astro@latest -- --template minimal
```

Expand All @@ -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/
Expand Down
4 changes: 2 additions & 2 deletions examples/non-html-pages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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/
Expand Down
2 changes: 1 addition & 1 deletion examples/portfolio/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Starter Kit: Portfolio

```
```sh
npm create astro@latest -- --template portfolio
```

Expand Down
4 changes: 2 additions & 2 deletions examples/with-markdoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This starter showcases the experimental Markdoc integration.

```
```sh
npm create astro@latest -- --template with-markdoc
```

Expand All @@ -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/
Expand Down
2 changes: 1 addition & 1 deletion examples/with-markdown-plugins/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Example: Markdown with Plugins

```
```sh
npm create astro@latest -- --template with-markdown-plugins
```

Expand Down
2 changes: 1 addition & 1 deletion examples/with-markdown-shiki/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Example: Markdown with Shiki

```
```sh
npm create astro@latest -- --template with-markdown-shiki
```

Expand Down
2 changes: 1 addition & 1 deletion examples/with-mdx/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Example: MDX

```
```sh
npm create astro@latest -- --template with-mdx
```

Expand Down
2 changes: 1 addition & 1 deletion examples/with-nanostores/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Example: Nanostores

```
```sh
npm create astro@latest -- --template with-nanostores
```

Expand Down
2 changes: 1 addition & 1 deletion examples/with-tailwindcss/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro with Tailwind

```
```sh
npm create astro@latest -- --template with-tailwindcss
```

Expand Down
4 changes: 2 additions & 2 deletions examples/with-vite-plugin-pwa/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro Starter Kit: Vite PWA

```
```sh
npm create astro@latest -- --template with-vite-plugin-pwa
```

Expand All @@ -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/
Expand Down
2 changes: 1 addition & 1 deletion examples/with-vitest/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Astro + [Vitest](https://vitest.dev/) Example

```
```sh
npm create astro@latest -- --template with-vitest
```

Expand Down

0 comments on commit 435b105

Please sign in to comment.