├── .changeset ├── README.md └── config.json ├── .github └── workflows │ └── release.yml ├── .gitignore ├── .npmrc ├── LICENSE.txt ├── README.md ├── demo ├── .gitignore ├── .npmrc ├── .vscode │ ├── extensions.json │ └── launch.json ├── CHANGELOG.md ├── README.md ├── astro.config.mjs ├── package.json ├── public │ ├── favicon.svg │ ├── placeholder-about.jpg │ ├── placeholder-hero.jpg │ └── placeholder-social.jpg ├── src │ ├── components │ │ ├── BaseHead.astro │ │ ├── Footer.astro │ │ ├── FormattedDate.astro │ │ ├── Header.astro │ │ └── HeaderLink.astro │ ├── consts.ts │ ├── content │ │ ├── blog │ │ │ ├── first-post.md │ │ │ ├── markdown-style-guide.md │ │ │ ├── second-post.md │ │ │ ├── third-post.md │ │ │ └── using-mdx.mdx │ │ └── config.ts │ ├── env.d.ts │ ├── layouts │ │ └── BlogPost.astro │ ├── pages │ │ ├── about.md │ │ ├── blog │ │ │ ├── [...slug].astro │ │ │ └── index.astro │ │ ├── docs.json.js │ │ ├── index.astro │ │ ├── rss.xml.js │ │ ├── search.astro │ │ └── search.json.js │ └── styles │ │ └── global.css └── tsconfig.json ├── package.json ├── packages └── astro-minisearch │ ├── CHANGELOG.md │ ├── README.md │ ├── api │ ├── README.md │ └── modules │ │ ├── collections.md │ │ ├── pages.md │ │ ├── plain_text_plugin.md │ │ ├── search_index.md │ │ └── types.md │ ├── package.json │ ├── src │ ├── collections.ts │ ├── index.ts │ ├── pages.ts │ ├── plain-text-plugin.ts │ ├── search-index.ts │ └── types.ts │ ├── tests │ ├── collections.ts │ ├── pages.ts │ ├── plain-text-plugin.ts │ └── search-index.ts │ ├── tsconfig.json │ └── typedoc.json ├── pnpm-lock.yaml └── pnpm-workspace.yaml /.changeset/README.md: -------------------------------------------------------------------------------- 1 | # Changesets 2 | 3 | Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works 4 | with multi-package repos, or single-package repos to help you version and publish your code. You can 5 | find the full documentation for it [in our repository](https://github.com/changesets/changesets) 6 | 7 | We have a quick list of common questions to get you started engaging with this project in 8 | [our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md) 9 | -------------------------------------------------------------------------------- /.changeset/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://unpkg.com/@changesets/config@2.1.1/schema.json", 3 | "changelog": "@changesets/cli/changelog", 4 | "commit": false, 5 | "fixed": [], 6 | "linked": [], 7 | "access": "restricted", 8 | "baseBranch": "main", 9 | "updateInternalDependencies": "patch", 10 | "ignore": [] 11 | } -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | 8 | concurrency: ${{ github.workflow }}-${{ github.ref }} 9 | 10 | jobs: 11 | release: 12 | name: Release 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v3 16 | - uses: pnpm/action-setup@v2 17 | with: 18 | version: 7 19 | - name: Setup Node.js 20 | uses: actions/setup-node@v3 21 | with: 22 | node-version: '16' 23 | cache: 'pnpm' 24 | - run: pnpm install --no-frozen-lockfile 25 | - run: pnpm ci:build 26 | - run: pnpm ci:test 27 | 28 | - name: Create Release Pull Request or Publish to npm 29 | id: changesets 30 | uses: changesets/action@v1 31 | with: 32 | publish: pnpm ci:publish 33 | env: 34 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 35 | NPM_TOKEN: ${{ secrets.NPM_TOKEN }} 36 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | pnpm-debug.log* 8 | lerna-debug.log* 9 | 10 | node_modules 11 | dist 12 | dist-ssr 13 | *.local 14 | 15 | # Editor directories and files 16 | .vscode/* 17 | !.vscode/extensions.json 18 | .idea 19 | .DS_Store 20 | *.suo 21 | *.ntvs* 22 | *.njsproj 23 | *.sln 24 | *.sw? 25 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | save-workspace-protocol=rolling -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Barnabas Kendall 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Astro + MiniSearch 2 | 3 | [Astro](https://astro.build/) is a website build tool for the modern web. 4 | [MiniSearch](https://github.com/lucaong/minisearch) is a tiny but powerful in-memory fulltext search engine that can comfortably run both in Node and in the browser. 5 | This project is some glue between them both. 6 | 7 | ## Directory 8 | 9 | This is a monorepo using [PNPM workspaces](https://pnpm.io/workspaces). 10 | Here's what's inside: 11 | 12 | - [packages/astro-minisearch](./packages/astro-minisearch/) - the main package 13 | - [demo](./demo/): sample search using Astro docs template 14 | 15 | ## Development 16 | 17 | This project is using [changesets](https://github.com/changesets/changesets). 18 | When submitting a PR, be sure to add a changeset describing the change. 19 | 20 | ### New changesets 21 | 22 | In the root directory run `pnpm changeset`. 23 | Answer the questions and commit temp files to the `.changeset` directory. 24 | 25 | ### Releases 26 | 27 | Releases are automatically handled by GitHub actions whenever a PR is merged. 28 | -------------------------------------------------------------------------------- /demo/.gitignore: -------------------------------------------------------------------------------- 1 | # build output 2 | dist/ 3 | # generated types 4 | .astro/ 5 | 6 | # dependencies 7 | node_modules/ 8 | 9 | # logs 10 | npm-debug.log* 11 | yarn-debug.log* 12 | yarn-error.log* 13 | pnpm-debug.log* 14 | 15 | 16 | # environment variables 17 | .env 18 | .env.production 19 | 20 | # macOS-specific files 21 | .DS_Store 22 | -------------------------------------------------------------------------------- /demo/.npmrc: -------------------------------------------------------------------------------- 1 | hoist=true 2 | hoist-pattern[]=shiki -------------------------------------------------------------------------------- /demo/.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": ["astro-build.astro-vscode"], 3 | "unwantedRecommendations": [] 4 | } 5 | -------------------------------------------------------------------------------- /demo/.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "command": "./node_modules/.bin/astro dev", 6 | "name": "Development server", 7 | "request": "launch", 8 | "type": "node-terminal" 9 | } 10 | ] 11 | } 12 | -------------------------------------------------------------------------------- /demo/CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # @example/docs 2 | 3 | ## 0.1.1 4 | 5 | ### Patch Changes 6 | 7 | - Updated dependencies [3d971c2] 8 | - @barnabask/astro-minisearch@2.1.1 9 | 10 | ## 0.1.0 11 | 12 | ### Minor Changes 13 | 14 | - 4c997b5: Allow promises and nested promises in `generateIndex` for better DX. 15 | Expose new `getDocuments` function for testing and debugging. 16 | Remove duplicates and missing URLs with a warning. 17 | Update demo to match new signature and include SSR search page. 18 | 19 | ### Patch Changes 20 | 21 | - Updated dependencies [220e3fc] 22 | - Updated dependencies [4c997b5] 23 | - @barnabask/astro-minisearch@2.1.0 24 | 25 | ## 0.0.2 26 | 27 | ### Patch Changes 28 | 29 | - Updated dependencies [b683dcd] 30 | - @barnabask/astro-minisearch@2.0.0 31 | 32 | ## 0.0.4 33 | 34 | ### Patch Changes 35 | 36 | - Updated dependencies [310bfb9] 37 | - @barnabask/astro-minisearch@1.1.1 38 | -------------------------------------------------------------------------------- /demo/README.md: -------------------------------------------------------------------------------- 1 | # Astro Starter Kit: Blog 2 | 3 | ``` 4 | npm create astro@latest -- --template blog 5 | ``` 6 | 7 | [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog) 8 | [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/blog) 9 | [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/blog/devcontainer.json) 10 | 11 | > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! 12 | 13 | 14 | ![blog](https://user-images.githubusercontent.com/4677417/186189140-4ef17aac-c3c9-4918-a8c2-ce86ba1bb394.png) 15 | 16 | Features: 17 | 18 | - ✅ Minimal styling (make it your own!) 19 | - ✅ 100/100 Lighthouse performance 20 | - ✅ SEO-friendly with canonical URLs and OpenGraph data 21 | - ✅ Sitemap support 22 | - ✅ RSS Feed support 23 | - ✅ Markdown & MDX support 24 | 25 | ## 🚀 Project Structure 26 | 27 | Inside of your Astro project, you'll see the following folders and files: 28 | 29 | ``` 30 | ├── public/ 31 | ├── src/ 32 | │   ├── components/ 33 | │   ├── content/ 34 | │   ├── layouts/ 35 | │   └── pages/ 36 | ├── astro.config.mjs 37 | ├── README.md 38 | ├── package.json 39 | └── tsconfig.json 40 | ``` 41 | 42 | Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. 43 | 44 | There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. 45 | 46 | The `src/content/` directory contains "collections" of related Markdown and MDX documents. Use `getCollection()` to retrieve posts from `src/content/blog/`, and type-check your frontmatter using an optional schema. See [Astro's Content Collections docs](https://docs.astro.build/en/guides/content-collections/) to learn more. 47 | 48 | Any static assets, like images, can be placed in the `public/` directory. 49 | 50 | ## 🧞 Commands 51 | 52 | All commands are run from the root of the project, from a terminal: 53 | 54 | | Command | Action | 55 | | :--------------------- | :----------------------------------------------- | 56 | | `npm install` | Installs dependencies | 57 | | `npm run dev` | Starts local dev server at `localhost:3000` | 58 | | `npm run build` | Build your production site to `./dist/` | 59 | | `npm run preview` | Preview your build locally, before deploying | 60 | | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | 61 | | `npm run astro --help` | Get help using the Astro CLI | 62 | 63 | ## 👀 Want to learn more? 64 | 65 | Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). 66 | 67 | ## Credit 68 | 69 | This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/). 70 | -------------------------------------------------------------------------------- /demo/astro.config.mjs: -------------------------------------------------------------------------------- 1 | import { defineConfig } from 'astro/config'; 2 | import mdx from '@astrojs/mdx'; 3 | import { plainTextPlugin } from "@barnabask/astro-minisearch"; 4 | import sitemap from '@astrojs/sitemap'; 5 | 6 | import node from "@astrojs/node"; 7 | 8 | // https://astro.build/config 9 | export default defineConfig({ 10 | site: 'https://example.com', 11 | integrations: [mdx(), sitemap()], 12 | markdown: { 13 | rehypePlugins: [plainTextPlugin()] 14 | }, 15 | output: "server", 16 | adapter: node({ 17 | mode: "standalone" 18 | }) 19 | }); -------------------------------------------------------------------------------- /demo/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "demo", 3 | "type": "module", 4 | "version": "0.1.1", 5 | "scripts": { 6 | "dev": "astro dev", 7 | "start": "astro dev", 8 | "build": "astro build", 9 | "preview": "astro preview", 10 | "astro": "astro" 11 | }, 12 | "dependencies": { 13 | "@astrojs/mdx": "^0.18.0", 14 | "@astrojs/node": "^5.1.0", 15 | "@astrojs/rss": "^2.2.0", 16 | "@astrojs/sitemap": "^1.2.0", 17 | "@barnabask/astro-minisearch": "workspace:*", 18 | "astro": "^2.1.2" 19 | } 20 | } -------------------------------------------------------------------------------- /demo/public/favicon.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 13 | 14 | -------------------------------------------------------------------------------- /demo/public/placeholder-about.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Barnabas/astro-minisearch/9fe0e736409e6c7ac4ae1d3af9fb7a4bc24bd365/demo/public/placeholder-about.jpg -------------------------------------------------------------------------------- /demo/public/placeholder-hero.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Barnabas/astro-minisearch/9fe0e736409e6c7ac4ae1d3af9fb7a4bc24bd365/demo/public/placeholder-hero.jpg -------------------------------------------------------------------------------- /demo/public/placeholder-social.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Barnabas/astro-minisearch/9fe0e736409e6c7ac4ae1d3af9fb7a4bc24bd365/demo/public/placeholder-social.jpg -------------------------------------------------------------------------------- /demo/src/components/BaseHead.astro: -------------------------------------------------------------------------------- 1 | --- 2 | // Import the global.css file here so that it is included on 3 | // all pages through the use of the component. 4 | import '../styles/global.css'; 5 | 6 | export interface Props { 7 | title: string; 8 | description: string; 9 | image?: string; 10 | } 11 | 12 | const canonicalURL = new URL(Astro.url.pathname, Astro.site); 13 | 14 | const { title, description, image = '/placeholder-social.jpg' } = Astro.props; 15 | --- 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | {title} 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /demo/src/components/Footer.astro: -------------------------------------------------------------------------------- 1 | --- 2 | const today = new Date(); 3 | --- 4 | 7 | 13 | -------------------------------------------------------------------------------- /demo/src/components/FormattedDate.astro: -------------------------------------------------------------------------------- 1 | --- 2 | let { date } = Astro.props; 3 | if(!date || !date.toISOString) date = new Date(); 4 | --- 5 | 6 | 15 | -------------------------------------------------------------------------------- /demo/src/components/Header.astro: -------------------------------------------------------------------------------- 1 | --- 2 | import HeaderLink from './HeaderLink.astro'; 3 | import { SITE_TITLE } from '../consts'; 4 | 5 | const requestUrl = new URL(Astro.request.url); 6 | const query = requestUrl.searchParams.get("query"); 7 | --- 8 | 9 |
10 |

11 | {SITE_TITLE} 12 |

13 | 24 |
25 | 41 | -------------------------------------------------------------------------------- /demo/src/components/HeaderLink.astro: -------------------------------------------------------------------------------- 1 | --- 2 | import type { HTMLAttributes } from 'astro/types'; 3 | 4 | type Props = HTMLAttributes<'a'>; 5 | 6 | const { href, class: className, ...props } = Astro.props; 7 | 8 | const { pathname } = Astro.url; 9 | const isActive = href === pathname || href === pathname.replace(/\/$/, ''); 10 | --- 11 | 12 | 13 | 14 | 15 | 25 | -------------------------------------------------------------------------------- /demo/src/consts.ts: -------------------------------------------------------------------------------- 1 | // Place any global data in this file. 2 | // You can import this data from anywhere in your site by using the `import` keyword. 3 | 4 | export const SITE_TITLE = 'Blog Search Demo'; 5 | export const SITE_DESCRIPTION = 'Welcome to my website!'; 6 | -------------------------------------------------------------------------------- /demo/src/content/blog/first-post.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "First post" 3 | description: "Lorem ipsum dolor sit amet" 4 | pubDate: "Jul 08 2022" 5 | heroImage: "/placeholder-hero.jpg" 6 | --- 7 | 8 | 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. 9 | 10 | 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. 11 | 12 | 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. 13 | 14 | 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. 15 | 16 | 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. 17 | -------------------------------------------------------------------------------- /demo/src/content/blog/markdown-style-guide.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Markdown Style Guide" 3 | description: "Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro." 4 | pubDate: "Jul 01 2022" 5 | heroImage: "/placeholder-hero.jpg" 6 | --- 7 | 8 | Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro. 9 | 10 | ## Headings 11 | 12 | The following HTML `

`—`

` elements represent six levels of section headings. `

` is the highest section level while `

` is the lowest. 13 | 14 | # H1 15 | 16 | ## H2 17 | 18 | ### H3 19 | 20 | #### H4 21 | 22 | ##### H5 23 | 24 | ###### H6 25 | 26 | ## Paragraph 27 | 28 | 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. 29 | 30 | Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. 31 | 32 | ## Images 33 | 34 | ![This is a placeholder image description](/placeholder-social.jpg) 35 | 36 | ## Blockquotes 37 | 38 | 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. 39 | 40 | #### Blockquote without attribution 41 | 42 | > Tiam, ad mint andaepu dandae nostion secatur sequo quae. 43 | > **Note** that you can use _Markdown syntax_ within a blockquote. 44 | 45 | #### Blockquote with attribution 46 | 47 | > Don't communicate by sharing memory, share memory by communicating.
48 | > — Rob Pike[^1] 49 | 50 | [^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015. 51 | 52 | ## Tables 53 | 54 | | Italics | Bold | Code | 55 | | --------- | -------- | ------ | 56 | | _italics_ | **bold** | `code` | 57 | 58 | ## Code Blocks 59 | 60 | ```html 61 | 62 | 63 | 64 | 65 | Example HTML5 Document 66 | 67 | 68 |

Test

69 | 70 | 71 | ``` 72 | 73 | ## List Types 74 | 75 | #### Ordered List 76 | 77 | 1. First item 78 | 2. Second item 79 | 3. Third item 80 | 81 | #### Unordered List 82 | 83 | - List item 84 | - Another item 85 | - And another item 86 | 87 | #### Nested list 88 | 89 | - Fruit 90 | - Apple 91 | - Orange 92 | - Banana 93 | - Dairy 94 | - Milk 95 | - Cheese 96 | 97 | ## Other Elements — abbr, sub, sup, kbd, mark 98 | 99 | GIF is a bitmap image format. 100 | 101 | H2O 102 | 103 | Xn + Yn = Zn 104 | 105 | Press CTRL+ALT+Delete to end the session. 106 | 107 | Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures. 108 | -------------------------------------------------------------------------------- /demo/src/content/blog/second-post.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Second post" 3 | description: "Lorem ipsum dolor sit amet" 4 | pubDate: "Jul 22 2022" 5 | heroImage: "/placeholder-hero.jpg" 6 | --- 7 | 8 | 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. 9 | 10 | 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. 11 | 12 | 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. 13 | 14 | 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. 15 | 16 | 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. 17 | -------------------------------------------------------------------------------- /demo/src/content/blog/third-post.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Third post" 3 | description: "Lorem ipsum dolor sit amet" 4 | pubDate: "Jul 15 2022" 5 | heroImage: "/placeholder-hero.jpg" 6 | --- 7 | 8 | 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. 9 | 10 | 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. 11 | 12 | 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. 13 | 14 | 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. 15 | 16 | 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. 17 | -------------------------------------------------------------------------------- /demo/src/content/blog/using-mdx.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: 'Using MDX' 3 | description: 'Lorem ipsum dolor sit amet' 4 | pubDate: 'Jul 02 2022' 5 | heroImage: '/placeholder-hero.jpg' 6 | --- 7 | 8 | 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. 9 | 10 | ## Why MDX? 11 | 12 | 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. 13 | 14 | If you have existing content authored in MDX, this integration will hopefully make migrating to Astro a breeze. 15 | 16 | ## Example 17 | 18 | Here is how you import and use a UI component inside of MDX. 19 | When you open this page in the browser, you should see the clickable button below. 20 | 21 | import HeaderLink from '../../components/HeaderLink.astro'; 22 | 23 | 24 | Embedded component in MDX 25 | 26 | 27 | ## More Links 28 | 29 | - [MDX Syntax Documentation](https://mdxjs.com/docs/what-is-mdx) 30 | - [Astro Usage Documentation](https://docs.astro.build/en/guides/markdown-content/#markdown-and-mdx-pages) 31 | - **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. 32 | -------------------------------------------------------------------------------- /demo/src/content/config.ts: -------------------------------------------------------------------------------- 1 | import { defineCollection, z } from 'astro:content'; 2 | 3 | const blog = defineCollection({ 4 | // Type-check frontmatter using a schema 5 | schema: z.object({ 6 | title: z.string(), 7 | description: z.string(), 8 | // Transform string to Date object 9 | pubDate: z 10 | .string() 11 | .or(z.date()) 12 | .transform((val) => new Date(val)), 13 | updatedDate: z 14 | .string() 15 | .optional() 16 | .transform((str) => (str ? new Date(str) : undefined)), 17 | heroImage: z.string().optional(), 18 | }), 19 | }); 20 | 21 | export const collections = { blog }; 22 | -------------------------------------------------------------------------------- /demo/src/env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | /// 3 | -------------------------------------------------------------------------------- /demo/src/layouts/BlogPost.astro: -------------------------------------------------------------------------------- 1 | --- 2 | import type { CollectionEntry } from 'astro:content'; 3 | import BaseHead from '../components/BaseHead.astro'; 4 | import Header from '../components/Header.astro'; 5 | import Footer from '../components/Footer.astro'; 6 | import FormattedDate from '../components/FormattedDate.astro'; 7 | 8 | type Props = CollectionEntry<'blog'>['data']; 9 | 10 | const { title, description, pubDate, updatedDate, heroImage } = Astro.props; 11 | --- 12 | 13 | 14 | 15 | 16 | 29 | 30 | 31 | 32 |
33 |
34 |
35 | {heroImage && } 36 |

{title}

37 | 38 | { 39 | updatedDate && ( 40 |
41 | Last updated on 42 |
43 | ) 44 | } 45 |
46 | 47 |
48 |
49 |