diff options
author | 2022-12-16 14:19:53 -0500 | |
---|---|---|
committer | 2022-12-16 14:19:53 -0500 | |
commit | 5ec0f6ed55b0a14a9663a90a03428345baf126bd (patch) | |
tree | d8d8a27888d43b78c84592f9a1a7d266b5968349 /examples/with-content/src | |
parent | 6f5746746a0bfcfe27e063489cad6a678804288f (diff) | |
download | astro-5ec0f6ed55b0a14a9663a90a03428345baf126bd.tar.gz astro-5ec0f6ed55b0a14a9663a90a03428345baf126bd.tar.zst astro-5ec0f6ed55b0a14a9663a90a03428345baf126bd.zip |
Content Collections (#5291)
* feat: port content plugin as-is
* feat: add `fetchContent` to `.astro`
* refactor: move more logic to content-internals
* refactor: move internals -> content dir
* feat: nested dir support
* feat: add with-content playground
* edit: update README
* fix: serialize route pattern for Netlify edge
Co-authored-by: Jackie Macharia <jackiewmacharia>
* wip: add ?astro-asset-ssr flag
* wip: exclude astro-ssr-asset styles from build
* revert: SSR asset flag babel changes
* feat: only load CSS when mdx is rendered!
* fix(vercel): Include all files inside `dist/` instead of only `entry.mjs` (#5175)
* chore: only-allow pnpm (#5131)
* [MDX] Support `recmaPlugins` config (#5146)
* feat: support recma plugins
* chore: add `test:match` to MDX
* chore: changeset
* docs: add recmaPlugins to README
* removes default content-visibility styles from image components (#5180)
* wip: check renderContent works
* nit: injectDelayedAssetPlugin doesn't need enforce
* feat: render content with generated entries
* feat: renderContent style injection POC
* wip: scrappy renderContent binding
* deps: parse-imports
* feat: only bind renderContent when imported
* feat: new-and-improved render-content
* fix: update example to use render-content
* refactor: extract normalizeFilename helper
* feat: move renderContent to `.astro`
* feat: add `getStaticPaths` demo π
* chore: remove console log
* refactor: internals -> internal
* fix: style bleed on dynamic routes
* chore: remove console log
* refactor: move rendercontentmap inside same file
* fix: style bleed in dev!
* feat: clean up example
* refactor: curry generateContent
* nit: add datetime demo
* refactor: rename and move content plugins
* feat: granular content updates in development
* chore: console.log
* refactor: move write logic, fix edge cases
* fix: use z.any() when ~schema is missing
* refactor: clean up logging
* fix: add delayed asset flag to render map
* fix: use new server loader
* chore: import type
* fix: split delayed assets to separate chunks
* chore: bad merge changesets
* feat: rework content map to Vite globs
* fix: formatted errors
* fix: get `renderContent` working with new APIs
* refactor: rename to getCollection, getEntry, renderEntry
* feat: streamline type alias!
* fix: check schema import is an import
* refactor: change ~schema -> index with defineCollection
* feat: auto apply env.d.ts reference
* feat: expose `headings` on `renderEntry`
* refactor: expose zod from astro/zod
* feat: add Collection util type
* refactor: generated types in src/content/
* edit: remove env.d.ts change from with-content
* feat: collectionToPaths utility
* refactor: migrate `examples/blog`
* refactor: simplify [...slug]
* fix: invalid date
* fix: renderEntry
* feat: migrate examples/docs to content!
* refactor: union -> enum
* fix: remove duplicate header
* chore: changeset
* Revert "fix: serialize route pattern for Netlify edge"
This reverts commit ac46a0d3238af1e6f8c3b8f235163385be1ff732.
* fix: lint
* fix: include zod in package files
* chore: push type gen for astro check
* feat: move to single defineCollections file
* feat: move examples to new collections model
* chore: type check valid collection names
* fix: ignore collections path in err logs
* refactor: content/index -> content/config
* refactor: defineCollections -> defineCollection
* fix: update docs to defineCollection
* chore: update with-content to new `astro:content` setup
* fix: renderEntry styles
* fix: bad Collection type
* fix: blog types generated
* feat: expose injectedFrontmatter on renderEntry
* chore: `import type`
* chore: add MDX to changeset
* fix: template package file
* fix: unneeded log on content config change
* chore: add `injectedFrontmatter` to generated types
* fix: escape import.meta.env in `body`
* fix: escape import.meta.env in frontmatter
* chore: unused import
* fix: use URL for config pathname
* feat: allow zod async transforms
* deps: devalue
* feat: custom slugs + better type checking
* fix: update types on config added or removed
* chore: add error msg for MDX preview release
* refactor: restore old normalizeFilename
* fix: add loadContentConfig error classes back
* Add initial tests for renderEntry
* add fixture tests
* Use head propagation APIs in renderEntry
* chore: new type gen
* fix: sort content keys before writing
* fix: avoid writing '.' collection with warning
* chore: docs types generated
* fix: generated types only once in build
* fix: use relative path to config for git
* chore: update generated types
* fix: glob pattern on valid exts
* feat: warn on possible collection typos
* chore: better error on bad lazy import
* fix: clear gray-matter cache for rawData
* fix: wait for config file while generating
* test: get collection and get entry basic
* test: multiple collections and entries
* test: add publishedDate test on entry
* tests: getStaticPaths integration
* test: ssr endpoint integration
* chore: consistent test names
* refactor: simplify generates... test
* chore: tests lockfile
* feat: add `experimental` flag
* chore: revert blog and docs examples
* chore: add experimental flag to with-content
* refactor: reuse contentFileExts
* refactor: make contentCollectionCss required
* chore: remove parse-imports dependency
* chore: remove unresolved idea redundancy
* chore: update changeset to minor v
* chore: clean up with-content pass 1
* refactor: de-monolith vite-plugin-content
* chore: remove maximum jank warning (it's acceptable jank)
* refactor: extract types-generator to separate file
* refactor: onEvent -> handleEvent
* edit: change content log to "types generated"
* fix: more experimental checks in prod build
* refactor: 2 jsToTreeNode calls -> 1
* feat: change with-content example to blog example
* fix: Content component type
* Fix use of renderEntry within a slot
* fix: warn for non-underscore _ files, refine logs
* chore: Content type in tests
* fix: types no updating with config changes
* fix: remove `result: SSRResult` type
* chore: entry var shadowing
* fix: bad experimental flag call
* wip: skip render entry tests
* fix: path resolution for .relative on windows
* chore: remove dead code
* wip: log entryPath into
* fix: use URL for entry
* refactor: getEntryInfo normalization
* refactor: move debounce to queueEvent only
* fix: resolve loader on config error
* fix: pathToFileURL -> new URL
* fix: dangerous pathname comparison
* refactor: move rawEvent -> event mapping to queueEvent
* fix: bad type
* wip: remove mkdir call
* wip: log content paths
* fix: more bad paths
* wip: more logs
* fix: correct glob path
* fix: normalize virtual mod path
* fix: content server file paths
* chore: remove render entry test skip
* wip: skip renderEntry tests (windows issues?)
* chore: remove console log
* feat: renderEntry -> render
* chore: add `--experimental-content-collections`
* refactor: only skip renderEntry tests on windows
* refactor: index.ts barrel export
* fix: cli type error
* fix: proper test skip on windows
* refactor: remove collectionToPaths :(
* refactor: use AstroError for frontmatter error
* nit: its schema, .*
* fix: bad isWindows import
* fix: await mod -> mod = await
Co-authored-by: Juan MartΓn Seery <me@juanm04.com>
Co-authored-by: θ±ζε±±ε€§ε£ <316783812@qq.com>
Co-authored-by: Tony Sullivan <tony.f.sullivan@outlook.com>
Co-authored-by: Matthew Phillips <matthew@skypack.dev>
Co-authored-by: bholmesdev <bholmesdev@gmail.com>
Diffstat (limited to 'examples/with-content/src')
19 files changed, 650 insertions, 0 deletions
diff --git a/examples/with-content/src/components/BaseHead.astro b/examples/with-content/src/components/BaseHead.astro new file mode 100644 index 000000000..ce60a7e77 --- /dev/null +++ b/examples/with-content/src/components/BaseHead.astro @@ -0,0 +1,38 @@ +--- +// Import the global.css file here so that it is included on +// all pages through the use of the <BaseHead /> component. +import '../styles/global.css'; + +export interface Props { + title: string; + description: string; + image?: string; +} + +const { title, description, image = '/placeholder-social.jpg' } = Astro.props; +--- + +<!-- Global Metadata --> +<meta charset="utf-8" /> +<meta name="viewport" content="width=device-width,initial-scale=1" /> +<link rel="icon" type="image/svg+xml" href="/favicon.svg" /> +<meta name="generator" content={Astro.generator} /> + +<!-- Primary Meta Tags --> +<title>{title}</title> +<meta name="title" content={title} /> +<meta name="description" content={description} /> + +<!-- Open Graph / Facebook --> +<meta property="og:type" content="website" /> +<meta property="og:url" content={Astro.url} /> +<meta property="og:title" content={title} /> +<meta property="og:description" content={description} /> +<meta property="og:image" content={new URL(image, Astro.url)} /> + +<!-- Twitter --> +<meta property="twitter:card" content="summary_large_image" /> +<meta property="twitter:url" content={Astro.url} /> +<meta property="twitter:title" content={title} /> +<meta property="twitter:description" content={description} /> +<meta property="twitter:image" content={new URL(image, Astro.url)} /> diff --git a/examples/with-content/src/components/Footer.astro b/examples/with-content/src/components/Footer.astro new file mode 100644 index 000000000..08395a4d1 --- /dev/null +++ b/examples/with-content/src/components/Footer.astro @@ -0,0 +1,13 @@ +--- +const today = new Date(); +--- + +<footer> + © {today.getFullYear()} YOUR NAME HERE. All rights reserved. +</footer> +<style> + footer { + padding: 25px; + text-align: center; + } +</style> diff --git a/examples/with-content/src/components/Header.astro b/examples/with-content/src/components/Header.astro new file mode 100644 index 000000000..4d3da1fcf --- /dev/null +++ b/examples/with-content/src/components/Header.astro @@ -0,0 +1,25 @@ +--- +import HeaderLink from './HeaderLink.astro'; +import { SITE_TITLE } from '../consts'; +--- + +<header> + <h2> + {SITE_TITLE} + </h2> + <nav> + <HeaderLink href="/">Home</HeaderLink> + <HeaderLink href="/blog">Blog</HeaderLink> + <HeaderLink href="/about">About</HeaderLink> + <HeaderLink href="https://twitter.com/astrodotbuild" target="_blank">Twitter</HeaderLink> + <HeaderLink href="https://github.com/withastro/astro" target="_blank">GitHub</HeaderLink> + </nav> +</header> +<style> + header { + margin: 0em 0 2em; + } + h2 { + margin: 0.5em 0; + } +</style> diff --git a/examples/with-content/src/components/HeaderLink.astro b/examples/with-content/src/components/HeaderLink.astro new file mode 100644 index 000000000..e8e2e103b --- /dev/null +++ b/examples/with-content/src/components/HeaderLink.astro @@ -0,0 +1,22 @@ +--- +export interface Props extends astroHTML.JSX.AnchorHTMLAttributes {} + +const { href, class: className, ...props } = Astro.props; + +const { pathname } = Astro.url; +const isActive = href === pathname || href === pathname.replace(/\/$/, ''); +--- + +<a href={href} class:list={[className, { active: isActive }]} {...props}> + <slot /> +</a> +<style> + a { + display: inline-block; + text-decoration: none; + } + a.active { + font-weight: bolder; + text-decoration: underline; + } +</style> diff --git a/examples/with-content/src/consts.ts b/examples/with-content/src/consts.ts new file mode 100644 index 000000000..1d5dbf632 --- /dev/null +++ b/examples/with-content/src/consts.ts @@ -0,0 +1,5 @@ +// Place any global data in this file. +// You can import this data from anywhere in your site by using the `import` keyword. + +export const SITE_TITLE = 'My personal website.'; +export const SITE_DESCRIPTION = 'Welcome to my website!'; diff --git a/examples/with-content/src/content/blog/first-post.md b/examples/with-content/src/content/blog/first-post.md new file mode 100644 index 000000000..33b844032 --- /dev/null +++ b/examples/with-content/src/content/blog/first-post.md @@ -0,0 +1,16 @@ +--- +title: "First post" +description: "Lorem ipsum dolor sit amet" +pubDate: "Jul 08 2022" +heroImage: "/placeholder-hero.jpg" +--- + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vitae ultricies leo integer malesuada nunc vel risus commodo viverra. Adipiscing enim eu turpis egestas pretium. Euismod elementum nisi quis eleifend quam adipiscing. In hac habitasse platea dictumst vestibulum. Sagittis purus sit amet volutpat. Netus et malesuada fames ac turpis egestas. Eget magna fermentum iaculis eu non diam phasellus vestibulum lorem. Varius sit amet mattis vulputate enim. Habitasse platea dictumst quisque sagittis. Integer quis auctor elit sed vulputate mi. Dictumst quisque sagittis purus sit amet. + +Morbi tristique senectus et netus. Id semper risus in hendrerit gravida rutrum quisque non tellus. Habitasse platea dictumst quisque sagittis purus sit amet. Tellus molestie nunc non blandit massa. Cursus vitae congue mauris rhoncus. Accumsan tortor posuere ac ut. Fringilla urna porttitor rhoncus dolor. Elit ullamcorper dignissim cras tincidunt lobortis. In cursus turpis massa tincidunt dui ut ornare lectus. Integer feugiat scelerisque varius morbi enim nunc. Bibendum neque egestas congue quisque egestas diam. Cras ornare arcu dui vivamus arcu felis bibendum. Dignissim suspendisse in est ante in nibh mauris. Sed tempus urna et pharetra pharetra massa massa ultricies mi. + +Mollis nunc sed id semper risus in. Convallis a cras semper auctor neque. Diam sit amet nisl suscipit. Lacus viverra vitae congue eu consequat ac felis donec. Egestas integer eget aliquet nibh praesent tristique magna sit amet. Eget magna fermentum iaculis eu non diam. In vitae turpis massa sed elementum. Tristique et egestas quis ipsum suspendisse ultrices. Eget lorem dolor sed viverra ipsum. Vel turpis nunc eget lorem dolor sed viverra. Posuere ac ut consequat semper viverra nam. Laoreet suspendisse interdum consectetur libero id faucibus. Diam phasellus vestibulum lorem sed risus ultricies tristique. Rhoncus dolor purus non enim praesent elementum facilisis. Ultrices tincidunt arcu non sodales neque. Tempus egestas sed sed risus pretium quam vulputate. Viverra suspendisse potenti nullam ac tortor vitae purus faucibus ornare. Fringilla urna porttitor rhoncus dolor purus non. Amet dictum sit amet justo donec enim. + +Mattis ullamcorper velit sed ullamcorper morbi tincidunt. Tortor posuere ac ut consequat semper viverra. Tellus mauris a diam maecenas sed enim ut sem viverra. Venenatis urna cursus eget nunc scelerisque viverra mauris in. Arcu ac tortor dignissim convallis aenean et tortor at. Curabitur gravida arcu ac tortor dignissim convallis aenean et tortor. Egestas tellus rutrum tellus pellentesque eu. Fusce ut placerat orci nulla pellentesque dignissim enim sit amet. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam. Id donec ultrices tincidunt arcu. Id cursus metus aliquam eleifend mi. + +Tempus quam pellentesque nec nam aliquam sem. Risus at ultrices mi tempus imperdiet. Id porta nibh venenatis cras sed felis eget velit. Ipsum a arcu cursus vitae. Facilisis magna etiam tempor orci eu lobortis elementum. Tincidunt dui ut ornare lectus sit. Quisque non tellus orci ac. Blandit libero volutpat sed cras. Nec tincidunt praesent semper feugiat nibh sed pulvinar proin gravida. Egestas integer eget aliquet nibh praesent tristique magna. diff --git a/examples/with-content/src/content/blog/markdown-style-guide.md b/examples/with-content/src/content/blog/markdown-style-guide.md new file mode 100644 index 000000000..1f221fb91 --- /dev/null +++ b/examples/with-content/src/content/blog/markdown-style-guide.md @@ -0,0 +1,102 @@ +--- +title: "Markdown Style Guide" +description: "Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro." +pubDate: "Jul 01 2022" +heroImage: "/placeholder-hero.jpg" +--- + +Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro. + +## Headings + +The following HTML `<h1>`β`<h6>` elements represent six levels of section headings. `<h1>` is the highest section level while `<h6>` is the lowest. + +# H1 +## H2 +### H3 +#### H4 +##### H5 +###### H6 + +## Paragraph + +Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat. + +Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. + +## Images + + + +## Blockquotes + +The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations. + +#### Blockquote without attribution + +> Tiam, ad mint andaepu dandae nostion secatur sequo quae. +> **Note** that you can use *Markdown syntax* within a blockquote. + +#### Blockquote with attribution + +> Don't communicate by sharing memory, share memory by communicating.<br> +> β <cite>Rob Pike[^1]</cite> + +[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015. + +## Tables + +| Italics | Bold | Code | +| -------- | -------- | ------ | +| *italics* | **bold** | `code` | + +## Code Blocks + +```html +<!doctype html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>Example HTML5 Document</title> +</head> +<body> + <p>Test</p> +</body> +</html> +``` + +## List Types + +#### Ordered List + +1. First item +2. Second item +3. Third item + +#### Unordered List + +* List item +* Another item +* And another item + +#### Nested list + +* Fruit + * Apple + * Orange + * Banana +* Dairy + * Milk + * Cheese + +## Other Elements β abbr, sub, sup, kbd, mark + +<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format. + +H<sub>2</sub>O + +X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup> + +Press <kbd><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the session. + +Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures. diff --git a/examples/with-content/src/content/blog/second-post.md b/examples/with-content/src/content/blog/second-post.md new file mode 100644 index 000000000..1bd5ee465 --- /dev/null +++ b/examples/with-content/src/content/blog/second-post.md @@ -0,0 +1,16 @@ +--- +title: "Second post" +description: "Lorem ipsum dolor sit amet" +pubDate: "Jul 22 2022" +heroImage: "/placeholder-hero.jpg" +--- + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vitae ultricies leo integer malesuada nunc vel risus commodo viverra. Adipiscing enim eu turpis egestas pretium. Euismod elementum nisi quis eleifend quam adipiscing. In hac habitasse platea dictumst vestibulum. Sagittis purus sit amet volutpat. Netus et malesuada fames ac turpis egestas. Eget magna fermentum iaculis eu non diam phasellus vestibulum lorem. Varius sit amet mattis vulputate enim. Habitasse platea dictumst quisque sagittis. Integer quis auctor elit sed vulputate mi. Dictumst quisque sagittis purus sit amet. + +Morbi tristique senectus et netus. Id semper risus in hendrerit gravida rutrum quisque non tellus. Habitasse platea dictumst quisque sagittis purus sit amet. Tellus molestie nunc non blandit massa. Cursus vitae congue mauris rhoncus. Accumsan tortor posuere ac ut. Fringilla urna porttitor rhoncus dolor. Elit ullamcorper dignissim cras tincidunt lobortis. In cursus turpis massa tincidunt dui ut ornare lectus. Integer feugiat scelerisque varius morbi enim nunc. Bibendum neque egestas congue quisque egestas diam. Cras ornare arcu dui vivamus arcu felis bibendum. Dignissim suspendisse in est ante in nibh mauris. Sed tempus urna et pharetra pharetra massa massa ultricies mi. + +Mollis nunc sed id semper risus in. Convallis a cras semper auctor neque. Diam sit amet nisl suscipit. Lacus viverra vitae congue eu consequat ac felis donec. Egestas integer eget aliquet nibh praesent tristique magna sit amet. Eget magna fermentum iaculis eu non diam. In vitae turpis massa sed elementum. Tristique et egestas quis ipsum suspendisse ultrices. Eget lorem dolor sed viverra ipsum. Vel turpis nunc eget lorem dolor sed viverra. Posuere ac ut consequat semper viverra nam. Laoreet suspendisse interdum consectetur libero id faucibus. Diam phasellus vestibulum lorem sed risus ultricies tristique. Rhoncus dolor purus non enim praesent elementum facilisis. Ultrices tincidunt arcu non sodales neque. Tempus egestas sed sed risus pretium quam vulputate. Viverra suspendisse potenti nullam ac tortor vitae purus faucibus ornare. Fringilla urna porttitor rhoncus dolor purus non. Amet dictum sit amet justo donec enim. + +Mattis ullamcorper velit sed ullamcorper morbi tincidunt. Tortor posuere ac ut consequat semper viverra. Tellus mauris a diam maecenas sed enim ut sem viverra. Venenatis urna cursus eget nunc scelerisque viverra mauris in. Arcu ac tortor dignissim convallis aenean et tortor at. Curabitur gravida arcu ac tortor dignissim convallis aenean et tortor. Egestas tellus rutrum tellus pellentesque eu. Fusce ut placerat orci nulla pellentesque dignissim enim sit amet. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam. Id donec ultrices tincidunt arcu. Id cursus metus aliquam eleifend mi. + +Tempus quam pellentesque nec nam aliquam sem. Risus at ultrices mi tempus imperdiet. Id porta nibh venenatis cras sed felis eget velit. Ipsum a arcu cursus vitae. Facilisis magna etiam tempor orci eu lobortis elementum. Tincidunt dui ut ornare lectus sit. Quisque non tellus orci ac. Blandit libero volutpat sed cras. Nec tincidunt praesent semper feugiat nibh sed pulvinar proin gravida. Egestas integer eget aliquet nibh praesent tristique magna. diff --git a/examples/with-content/src/content/blog/third-post.md b/examples/with-content/src/content/blog/third-post.md new file mode 100644 index 000000000..d7f1f24b0 --- /dev/null +++ b/examples/with-content/src/content/blog/third-post.md @@ -0,0 +1,16 @@ +--- +title: "Third post" +description: "Lorem ipsum dolor sit amet" +pubDate: "Jul 15 2022" +heroImage: "/placeholder-hero.jpg" +--- + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vitae ultricies leo integer malesuada nunc vel risus commodo viverra. Adipiscing enim eu turpis egestas pretium. Euismod elementum nisi quis eleifend quam adipiscing. In hac habitasse platea dictumst vestibulum. Sagittis purus sit amet volutpat. Netus et malesuada fames ac turpis egestas. Eget magna fermentum iaculis eu non diam phasellus vestibulum lorem. Varius sit amet mattis vulputate enim. Habitasse platea dictumst quisque sagittis. Integer quis auctor elit sed vulputate mi. Dictumst quisque sagittis purus sit amet. + +Morbi tristique senectus et netus. Id semper risus in hendrerit gravida rutrum quisque non tellus. Habitasse platea dictumst quisque sagittis purus sit amet. Tellus molestie nunc non blandit massa. Cursus vitae congue mauris rhoncus. Accumsan tortor posuere ac ut. Fringilla urna porttitor rhoncus dolor. Elit ullamcorper dignissim cras tincidunt lobortis. In cursus turpis massa tincidunt dui ut ornare lectus. Integer feugiat scelerisque varius morbi enim nunc. Bibendum neque egestas congue quisque egestas diam. Cras ornare arcu dui vivamus arcu felis bibendum. Dignissim suspendisse in est ante in nibh mauris. Sed tempus urna et pharetra pharetra massa massa ultricies mi. + +Mollis nunc sed id semper risus in. Convallis a cras semper auctor neque. Diam sit amet nisl suscipit. Lacus viverra vitae congue eu consequat ac felis donec. Egestas integer eget aliquet nibh praesent tristique magna sit amet. Eget magna fermentum iaculis eu non diam. In vitae turpis massa sed elementum. Tristique et egestas quis ipsum suspendisse ultrices. Eget lorem dolor sed viverra ipsum. Vel turpis nunc eget lorem dolor sed viverra. Posuere ac ut consequat semper viverra nam. Laoreet suspendisse interdum consectetur libero id faucibus. Diam phasellus vestibulum lorem sed risus ultricies tristique. Rhoncus dolor purus non enim praesent elementum facilisis. Ultrices tincidunt arcu non sodales neque. Tempus egestas sed sed risus pretium quam vulputate. Viverra suspendisse potenti nullam ac tortor vitae purus faucibus ornare. Fringilla urna porttitor rhoncus dolor purus non. Amet dictum sit amet justo donec enim. + +Mattis ullamcorper velit sed ullamcorper morbi tincidunt. Tortor posuere ac ut consequat semper viverra. Tellus mauris a diam maecenas sed enim ut sem viverra. Venenatis urna cursus eget nunc scelerisque viverra mauris in. Arcu ac tortor dignissim convallis aenean et tortor at. Curabitur gravida arcu ac tortor dignissim convallis aenean et tortor. Egestas tellus rutrum tellus pellentesque eu. Fusce ut placerat orci nulla pellentesque dignissim enim sit amet. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam. Id donec ultrices tincidunt arcu. Id cursus metus aliquam eleifend mi. + +Tempus quam pellentesque nec nam aliquam sem. Risus at ultrices mi tempus imperdiet. Id porta nibh venenatis cras sed felis eget velit. Ipsum a arcu cursus vitae. Facilisis magna etiam tempor orci eu lobortis elementum. Tincidunt dui ut ornare lectus sit. Quisque non tellus orci ac. Blandit libero volutpat sed cras. Nec tincidunt praesent semper feugiat nibh sed pulvinar proin gravida. Egestas integer eget aliquet nibh praesent tristique magna. diff --git a/examples/with-content/src/content/blog/using-mdx.mdx b/examples/with-content/src/content/blog/using-mdx.mdx new file mode 100644 index 000000000..036209d3b --- /dev/null +++ b/examples/with-content/src/content/blog/using-mdx.mdx @@ -0,0 +1,31 @@ +--- +title: 'Using MDX' +description: 'Lorem ipsum dolor sit amet' +pubDate: 'Jul 02 2022' +heroImage: '/placeholder-hero.jpg' +--- + +This theme comes with the [@astrojs/mdx](https://docs.astro.build/en/guides/integrations-guide/mdx/) integration installed and configured in your `astro.config.mjs` config file. If you prefer not to use MDX, you can disable support by removing the integration from your config file. + +## Why MDX? + +MDX is a special flavor of Markdown that supports embedded JavaScript & JSX syntax. This unlocks the ability to [mix JavaScript and UI Components into your Markdown content](https://docs.astro.build/en/guides/markdown-content/#mdx-features) for things like interactive charts or alerts. + +If you have existing content authored in MDX, this integration will hopefully make migrating to Astro a breeze. + +## Example + +Here is how you import and use a UI component inside of MDX. +When you open this page in the browser, you should see the clickable button below. + +import HeaderLink from '../../components/HeaderLink.astro'; + +<HeaderLink href="#" onclick="alert('clicked!')"> + Embedded component in MDX +</HeaderLink> + +## More Links + +- [MDX Syntax Documentation](https://mdxjs.com/docs/what-is-mdx) +- [Astro Usage Documentation](https://docs.astro.build/en/guides/markdown-content/#markdown-and-mdx-pages) +- **Note:** [Client Directives](https://docs.astro.build/en/reference/directives-reference/#client-directives) are still required to create interactive components. Otherwise, all components in your MDX will render as static HTML (no JavaScript) by default. diff --git a/examples/with-content/src/content/config.ts b/examples/with-content/src/content/config.ts new file mode 100644 index 000000000..9d436060a --- /dev/null +++ b/examples/with-content/src/content/config.ts @@ -0,0 +1,18 @@ +import { defineCollection, z } from 'astro:content'; + +const blog = defineCollection({ + // Type-check frontmatter using a schema + schema: { + title: z.string(), + description: z.string(), + // Transform string to Date object + pubDate: z.string().transform((str) => new Date(str)), + updatedDate: z + .string() + .optional() + .transform((str) => (str ? new Date(str) : undefined)), + heroImage: z.string().optional(), + }, +}); + +export const collections = { blog }; diff --git a/examples/with-content/src/content/types.generated.d.ts b/examples/with-content/src/content/types.generated.d.ts new file mode 100644 index 000000000..af803d2cf --- /dev/null +++ b/examples/with-content/src/content/types.generated.d.ts @@ -0,0 +1,86 @@ +declare module 'astro:content' { + export { z } from 'astro/zod'; + export type CollectionEntry<C extends keyof typeof entryMap> = + typeof entryMap[C][keyof typeof entryMap[C]] & Render; + + type BaseCollectionConfig<S extends import('astro/zod').ZodRawShape> = { + schema?: S; + slug?: (entry: { + id: CollectionEntry<keyof typeof entryMap>['id']; + defaultSlug: string; + collection: string; + body: string; + data: import('astro/zod').infer<import('astro/zod').ZodObject<S>>; + }) => string | Promise<string>; + }; + export function defineCollection<S extends import('astro/zod').ZodRawShape>( + input: BaseCollectionConfig<S> + ): BaseCollectionConfig<S>; + + export function getEntry<C extends keyof typeof entryMap, E extends keyof typeof entryMap[C]>( + collection: C, + entryKey: E + ): Promise<typeof entryMap[C][E] & Render>; + export function getCollection< + C extends keyof typeof entryMap, + E extends keyof typeof entryMap[C] + >( + collection: C, + filter?: (data: typeof entryMap[C][E]) => boolean + ): Promise<(typeof entryMap[C][E] & Render)[]>; + + type InferEntrySchema<C extends keyof typeof entryMap> = import('astro/zod').infer< + import('astro/zod').ZodObject<Required<ContentConfig['collections'][C]>['schema']> + >; + + type Render = { + render(): Promise<{ + Content: import('astro').MarkdownInstance<{}>['Content']; + headings: import('astro').MarkdownHeading[]; + injectedFrontmatter: Record<string, any>; + }>; + }; + + const entryMap: { + "blog": { +"first-post.md": { + id: "first-post.md", + slug: "first-post", + body: string, + collection: "blog", + data: InferEntrySchema<"blog"> +}, +"markdown-style-guide.md": { + id: "markdown-style-guide.md", + slug: "markdown-style-guide", + body: string, + collection: "blog", + data: InferEntrySchema<"blog"> +}, +"second-post.md": { + id: "second-post.md", + slug: "second-post", + body: string, + collection: "blog", + data: InferEntrySchema<"blog"> +}, +"third-post.md": { + id: "third-post.md", + slug: "third-post", + body: string, + collection: "blog", + data: InferEntrySchema<"blog"> +}, +"using-mdx.mdx": { + id: "using-mdx.mdx", + slug: "using-mdx", + body: string, + collection: "blog", + data: InferEntrySchema<"blog"> +}, +}, + + }; + + type ContentConfig = typeof import("./config"); +} diff --git a/examples/with-content/src/env.d.ts b/examples/with-content/src/env.d.ts new file mode 100644 index 000000000..f964fe0cf --- /dev/null +++ b/examples/with-content/src/env.d.ts @@ -0,0 +1 @@ +/// <reference types="astro/client" /> diff --git a/examples/with-content/src/layouts/BlogPost.astro b/examples/with-content/src/layouts/BlogPost.astro new file mode 100644 index 000000000..c2527082a --- /dev/null +++ b/examples/with-content/src/layouts/BlogPost.astro @@ -0,0 +1,49 @@ +--- +import BaseHead from '../components/BaseHead.astro'; +import Header from '../components/Header.astro'; +import Footer from '../components/Footer.astro'; +import type { CollectionEntry } from 'astro:content'; + +type Props = CollectionEntry<'blog'>['data']; + +const { + title, description, pubDate, updatedDate, heroImage, +} = Astro.props; +--- + +<html lang="en"> + <head> + <BaseHead title={title} description={description} /> + <style> + .title { + font-size: 2em; + margin: 0.25em 0 0; + } + hr { + border-top: 1px solid #ddd; + margin: 1rem 0; + } + </style> + </head> + + <body> + <Header /> + <main> + <article> + {heroImage && <img width={720} height={360} src={heroImage} alt="" />} + <h1 class="title">{title}</h1> + {pubDate && <time>{pubDate}</time>} + { + updatedDate && ( + <div> + Last updated on <time>{updatedDate}</time> + </div> + ) + } + <hr /> + <slot /> + </article> + </main> + <Footer /> + </body> +</html> diff --git a/examples/with-content/src/pages/about.md b/examples/with-content/src/pages/about.md new file mode 100644 index 000000000..2aeb6562e --- /dev/null +++ b/examples/with-content/src/pages/about.md @@ -0,0 +1,17 @@ +--- +layout: "../layouts/BlogPost.astro" +title: "About Me" +description: "Lorem ipsum dolor sit amet" +updatedDate: "August 08 2022" +heroImage: "/placeholder-about.jpg" +--- + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Vitae ultricies leo integer malesuada nunc vel risus commodo viverra. Adipiscing enim eu turpis egestas pretium. Euismod elementum nisi quis eleifend quam adipiscing. In hac habitasse platea dictumst vestibulum. Sagittis purus sit amet volutpat. Netus et malesuada fames ac turpis egestas. Eget magna fermentum iaculis eu non diam phasellus vestibulum lorem. Varius sit amet mattis vulputate enim. Habitasse platea dictumst quisque sagittis. Integer quis auctor elit sed vulputate mi. Dictumst quisque sagittis purus sit amet. + +Morbi tristique senectus et netus. Id semper risus in hendrerit gravida rutrum quisque non tellus. Habitasse platea dictumst quisque sagittis purus sit amet. Tellus molestie nunc non blandit massa. Cursus vitae congue mauris rhoncus. Accumsan tortor posuere ac ut. Fringilla urna porttitor rhoncus dolor. Elit ullamcorper dignissim cras tincidunt lobortis. In cursus turpis massa tincidunt dui ut ornare lectus. Integer feugiat scelerisque varius morbi enim nunc. Bibendum neque egestas congue quisque egestas diam. Cras ornare arcu dui vivamus arcu felis bibendum. Dignissim suspendisse in est ante in nibh mauris. Sed tempus urna et pharetra pharetra massa massa ultricies mi. + +Mollis nunc sed id semper risus in. Convallis a cras semper auctor neque. Diam sit amet nisl suscipit. Lacus viverra vitae congue eu consequat ac felis donec. Egestas integer eget aliquet nibh praesent tristique magna sit amet. Eget magna fermentum iaculis eu non diam. In vitae turpis massa sed elementum. Tristique et egestas quis ipsum suspendisse ultrices. Eget lorem dolor sed viverra ipsum. Vel turpis nunc eget lorem dolor sed viverra. Posuere ac ut consequat semper viverra nam. Laoreet suspendisse interdum consectetur libero id faucibus. Diam phasellus vestibulum lorem sed risus ultricies tristique. Rhoncus dolor purus non enim praesent elementum facilisis. Ultrices tincidunt arcu non sodales neque. Tempus egestas sed sed risus pretium quam vulputate. Viverra suspendisse potenti nullam ac tortor vitae purus faucibus ornare. Fringilla urna porttitor rhoncus dolor purus non. Amet dictum sit amet justo donec enim. + +Mattis ullamcorper velit sed ullamcorper morbi tincidunt. Tortor posuere ac ut consequat semper viverra. Tellus mauris a diam maecenas sed enim ut sem viverra. Venenatis urna cursus eget nunc scelerisque viverra mauris in. Arcu ac tortor dignissim convallis aenean et tortor at. Curabitur gravida arcu ac tortor dignissim convallis aenean et tortor. Egestas tellus rutrum tellus pellentesque eu. Fusce ut placerat orci nulla pellentesque dignissim enim sit amet. Ut enim blandit volutpat maecenas volutpat blandit aliquam etiam. Id donec ultrices tincidunt arcu. Id cursus metus aliquam eleifend mi. + +Tempus quam pellentesque nec nam aliquam sem. Risus at ultrices mi tempus imperdiet. Id porta nibh venenatis cras sed felis eget velit. Ipsum a arcu cursus vitae. Facilisis magna etiam tempor orci eu lobortis elementum. Tincidunt dui ut ornare lectus sit. Quisque non tellus orci ac. Blandit libero volutpat sed cras. Nec tincidunt praesent semper feugiat nibh sed pulvinar proin gravida. Egestas integer eget aliquet nibh praesent tristique magna.
\ No newline at end of file diff --git a/examples/with-content/src/pages/blog/[...slug].astro b/examples/with-content/src/pages/blog/[...slug].astro new file mode 100644 index 000000000..c8e86c487 --- /dev/null +++ b/examples/with-content/src/pages/blog/[...slug].astro @@ -0,0 +1,21 @@ +--- +import { CollectionEntry, getCollection } from "astro:content"; +import BlogPost from "../../layouts/BlogPost.astro"; + +export async function getStaticPaths() { + const posts = await getCollection('blog'); + return posts.map(post => ({ + params: { slug: post.slug }, + props: post, + })); +} +type Props = CollectionEntry<'blog'>; + +const post = Astro.props; +const { Content } = await post.render(); +--- + +<BlogPost {...post.data}> + <h1>{post.data.title}</h1> + <Content /> +</BlogPost> diff --git a/examples/with-content/src/pages/blog/index.astro b/examples/with-content/src/pages/blog/index.astro new file mode 100644 index 000000000..e4f769f8a --- /dev/null +++ b/examples/with-content/src/pages/blog/index.astro @@ -0,0 +1,57 @@ +--- +import BaseHead from '../../components/BaseHead.astro'; +import Header from '../../components/Header.astro'; +import Footer from '../../components/Footer.astro'; +import { SITE_TITLE, SITE_DESCRIPTION } from '../../consts'; +import { getCollection } from 'astro:content'; + +const posts = (await getCollection('blog')).sort( + (a, b) => a.data.pubDate.valueOf() - b.data.pubDate.valueOf() +) +--- + +<!DOCTYPE html> +<html lang="en"> + <head> + <BaseHead title={SITE_TITLE} description={SITE_DESCRIPTION} /> + <style> + ul { + list-style-type: none; + padding: unset; + } + ul li { + display: flex; + } + ul li time { + flex: 0 0 130px; + font-style: italic; + color: #595959; + } + ul li a:visited { + color: #8e32dc; + } + </style> + </head> + <body> + <Header /> + <main> + <section> + <ul> + {posts.map((post) => ( + <li> + <time datetime={post.data.pubDate.toISOString()}> + {post.data.pubDate.toLocaleDateString('en-us', { + year: 'numeric', + month: 'short', + day: 'numeric', + })} + </time> + <a href={'/blog/' + post.slug}>{post.data.title}</a> + </li> + ))} + </ul> + </section> + </main> + <Footer /> + </body> +</html> diff --git a/examples/with-content/src/pages/index.astro b/examples/with-content/src/pages/index.astro new file mode 100644 index 000000000..26f070da5 --- /dev/null +++ b/examples/with-content/src/pages/index.astro @@ -0,0 +1,50 @@ +--- +import BaseHead from '../components/BaseHead.astro'; +import Header from '../components/Header.astro'; +import Footer from '../components/Footer.astro'; +import { SITE_TITLE, SITE_DESCRIPTION } from '../consts'; +--- + +<!DOCTYPE html> +<html lang="en"> + <head> + <BaseHead title={SITE_TITLE} description={SITE_DESCRIPTION} /> + </head> + <body> + <Header title={SITE_TITLE} /> + <main> + <h1>π§βπ Hello, Astronaut!</h1> + <p> + Welcome to the official <a href="https://astro.build/">Astro</a> blog starter template. This + template serves as a lightweight, minimally-styled starting point for anyone looking to build + a personal website, blog, or portfolio with Astro. + </p> + <p> + This template comes with a few integrations already configured in your + <code>astro.config.mjs</code> file. You can customize your setup with + <a href="https://astro.build/integrations">Astro Integrations</a> to add tools like Tailwind, + React, or Vue to your project. + </p> + <p>Here are a few ideas on how to get started with the template:</p> + <ul> + <li>Edit this page in <code>src/pages/index.astro</code></li> + <li>Edit the site header items in <code>src/components/Header.astro</code></li> + <li>Add your name to the footer in <code>src/components/Footer.astro</code></li> + <li>Check out the included blog posts in <code>src/pages/blog/</code></li> + <li>Customize the blog post page layout in <code>src/layouts/BlogPost.astro</code></li> + </ul> + <p> + Have fun! If you get stuck, remember to <a href="https://docs.astro.build/" + >read the docs + </a> or <a href="https://astro.build/chat">join us on Discord</a> to ask questions. + </p> + <p> + Looking for a blog template with a bit more personality? Check out <a + href="https://github.com/Charca/astro-blog-template" + >astro-blog-template + </a> by <a href="https://twitter.com/Charca">Maxi Ferreira</a>. + </p> + </main> + <Footer /> + </body> +</html> diff --git a/examples/with-content/src/styles/global.css b/examples/with-content/src/styles/global.css new file mode 100644 index 000000000..999782ff2 --- /dev/null +++ b/examples/with-content/src/styles/global.css @@ -0,0 +1,67 @@ +/* + The CSS in this style tag is based off of Bear Blog's default CSS. + https://github.com/HermanMartinus/bearblog/blob/297026a877bc2ab2b3bdfbd6b9f7961c350917dd/templates/styles/blog/default.css + License MIT: https://github.com/HermanMartinus/bearblog/blob/master/LICENSE.md + */ +body { + font-family: Verdana, sans-serif; + margin: auto; + padding: 20px; + max-width: 65ch; + text-align: left; + background-color: #fff; + word-wrap: break-word; + overflow-wrap: break-word; + line-height: 1.5; + color: #444; +} +h1, +h2, +h3, +h4, +h5, +h6, +strong, +b { + color: #222; +} +a { + color: #3273dc; +} +nav a { + margin-right: 10px; +} +textarea { + width: 100%; + font-size: 16px; +} +input { + font-size: 16px; +} +content { + line-height: 1.6; +} +table { + width: 100%; +} +img { + max-width: 100%; + height: auto; +} +code { + padding: 2px 5px; + background-color: #f2f2f2; +} +pre { + padding: 1rem; +} +pre > code { + all: unset; +} +blockquote { + border: 1px solid #999; + color: #222; + padding: 2px 0px 2px 20px; + margin: 0px; + font-style: italic; +} |