mirror of
https://github.com/withastro/astro.git
synced 2024-12-16 21:46:22 -05:00
Sync from a44cfb874a
This commit is contained in:
github-actions[bot]
commit
c6f8e7764d
15 changed files with 380 additions and 0 deletions
1
.codesandbox/Dockerfile
Normal file
1
.codesandbox/Dockerfile
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
FROM node:18-bullseye
|
||||||
24
.gitignore
vendored
Normal file
24
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
# 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
|
||||||
|
|
||||||
|
# jetbrains setting folder
|
||||||
|
.idea/
|
||||||
4
.vscode/extensions.json
vendored
Normal file
4
.vscode/extensions.json
vendored
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"recommendations": ["astro-build.astro-vscode"],
|
||||||
|
"unwantedRecommendations": []
|
||||||
|
}
|
||||||
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "./node_modules/.bin/astro dev",
|
||||||
|
"name": "Development server",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
56
README.md
Normal file
56
README.md
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
# Astro Example: Markdoc (experimental)
|
||||||
|
|
||||||
|
This starter showcases the experimental Markdoc integration.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm create astro@latest -- --template with-markdoc
|
||||||
|
```
|
||||||
|
|
||||||
|
[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdoc)
|
||||||
|
[](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:
|
||||||
|
|
||||||
|
```text
|
||||||
|
/
|
||||||
|
├── public/
|
||||||
|
├── src/
|
||||||
|
│ └── content/
|
||||||
|
└── docs/
|
||||||
|
│ └── intro.mdoc
|
||||||
|
| └── config.ts
|
||||||
|
│ └── components/Aside.astro
|
||||||
|
│ └── layouts/Layout.astro
|
||||||
|
│ └── pages/index.astro
|
||||||
|
| └── env.d.ts
|
||||||
|
├── astro.config.mjs
|
||||||
|
├── markdoc.config.mjs
|
||||||
|
├── README.md
|
||||||
|
├── package.json
|
||||||
|
└── tsconfig.json
|
||||||
|
```
|
||||||
|
|
||||||
|
Markdoc (`.mdoc`) files can be used in content collections. See `src/content/docs/` for an example file.
|
||||||
|
|
||||||
|
You can also render Astro components from your Markdoc files using [tags](https://markdoc.dev/docs/tags). See the `markdoc.config.mjs` file for an example configuration.
|
||||||
|
|
||||||
|
## 🧞 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:4321` |
|
||||||
|
| `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).
|
||||||
8
astro.config.mjs
Normal file
8
astro.config.mjs
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
// @ts-check
|
||||||
|
import { defineConfig } from 'astro/config';
|
||||||
|
import markdoc from '@astrojs/markdoc';
|
||||||
|
|
||||||
|
// https://astro.build/config
|
||||||
|
export default defineConfig({
|
||||||
|
integrations: [markdoc()],
|
||||||
|
});
|
||||||
13
markdoc.config.mjs
Normal file
13
markdoc.config.mjs
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
import { defineMarkdocConfig, component } from '@astrojs/markdoc/config';
|
||||||
|
|
||||||
|
export default defineMarkdocConfig({
|
||||||
|
tags: {
|
||||||
|
aside: {
|
||||||
|
render: component('./src/components/Aside.astro'),
|
||||||
|
attributes: {
|
||||||
|
type: { type: String },
|
||||||
|
title: { type: String },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
16
package.json
Normal file
16
package.json
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
{
|
||||||
|
"name": "@example/with-markdoc",
|
||||||
|
"type": "module",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"private": true,
|
||||||
|
"scripts": {
|
||||||
|
"dev": "astro dev",
|
||||||
|
"build": "astro build",
|
||||||
|
"preview": "astro preview",
|
||||||
|
"astro": "astro"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@astrojs/markdoc": "^0.12.3",
|
||||||
|
"astro": "^5.0.8"
|
||||||
|
}
|
||||||
|
}
|
||||||
9
public/favicon.svg
Normal file
9
public/favicon.svg
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 128 128">
|
||||||
|
<path d="M50.4 78.5a75.1 75.1 0 0 0-28.5 6.9l24.2-65.7c.7-2 1.9-3.2 3.4-3.2h29c1.5 0 2.7 1.2 3.4 3.2l24.2 65.7s-11.6-7-28.5-7L67 45.5c-.4-1.7-1.6-2.8-2.9-2.8-1.3 0-2.5 1.1-2.9 2.7L50.4 78.5Zm-1.1 28.2Zm-4.2-20.2c-2 6.6-.6 15.8 4.2 20.2a17.5 17.5 0 0 1 .2-.7 5.5 5.5 0 0 1 5.7-4.5c2.8.1 4.3 1.5 4.7 4.7.2 1.1.2 2.3.2 3.5v.4c0 2.7.7 5.2 2.2 7.4a13 13 0 0 0 5.7 4.9v-.3l-.2-.3c-1.8-5.6-.5-9.5 4.4-12.8l1.5-1a73 73 0 0 0 3.2-2.2 16 16 0 0 0 6.8-11.4c.3-2 .1-4-.6-6l-.8.6-1.6 1a37 37 0 0 1-22.4 2.7c-5-.7-9.7-2-13.2-6.2Z" />
|
||||||
|
<style>
|
||||||
|
path { fill: #000; }
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
path { fill: #FFF; }
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 749 B |
116
src/components/Aside.astro
Normal file
116
src/components/Aside.astro
Normal file
|
|
@ -0,0 +1,116 @@
|
||||||
|
---
|
||||||
|
// Inspired by the `Aside` component from docs.astro.build
|
||||||
|
// https://github.com/withastro/starlight/blob/main/packages/starlight/integrations/asides.ts
|
||||||
|
|
||||||
|
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>
|
||||||
5
src/content.config.ts
Normal file
5
src/content.config.ts
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
import { defineCollection } from 'astro:content';
|
||||||
|
|
||||||
|
export const collections = {
|
||||||
|
docs: defineCollection({})
|
||||||
|
};
|
||||||
39
src/content/docs/intro.mdoc
Normal file
39
src/content/docs/intro.mdoc
Normal 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` to your list of Markdoc variables.
|
||||||
|
|
||||||
|
_Hint: Try passing as a prop to the `<Content />` component in the `src/pages/index.astro` file._
|
||||||
|
|
||||||
|
{% if $revealSecret %}
|
||||||
|
|
||||||
|
Maybe the real secret was the Rick Rolls we shared along the way.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{% /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/
|
||||||
42
src/layouts/Layout.astro
Normal file
42
src/layouts/Layout.astro
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
---
|
||||||
|
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>
|
||||||
28
src/pages/index.astro
Normal file
28
src/pages/index.astro
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
---
|
||||||
|
import { getEntry } from 'astro:content';
|
||||||
|
import Layout from '../layouts/Layout.astro';
|
||||||
|
|
||||||
|
const intro = await getEntry('docs', 'intro');
|
||||||
|
if (!intro) {
|
||||||
|
return Astro.redirect('/404');
|
||||||
|
}
|
||||||
|
const { Content } = await intro.render();
|
||||||
|
---
|
||||||
|
|
||||||
|
<Layout title={intro.data.title}>
|
||||||
|
<main>
|
||||||
|
<h1>{intro.data.title}</h1>
|
||||||
|
<Content />
|
||||||
|
</main>
|
||||||
|
</Layout>
|
||||||
|
|
||||||
|
<style is:global>
|
||||||
|
table {
|
||||||
|
margin-block: 2rem;
|
||||||
|
margin-inline: auto;
|
||||||
|
}
|
||||||
|
table td {
|
||||||
|
padding-block: 0.3rem;
|
||||||
|
padding-inline: 0.5rem;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
8
tsconfig.json
Normal file
8
tsconfig.json
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
{
|
||||||
|
"extends": "astro/tsconfigs/strict",
|
||||||
|
"include": [".astro/types.d.ts", "**/*"],
|
||||||
|
"exclude": ["dist"],
|
||||||
|
"compilerOptions": {
|
||||||
|
"strictNullChecks": true
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue