aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jonathan Neal <jonathantneal@hotmail.com> 2021-11-11 12:09:48 -0500
committerGravatar GitHub <noreply@github.com> 2021-11-11 12:09:48 -0500
commite0c3318c09c6d8158e51d09e88eae32bb26f7bb7 (patch)
tree3e61b44ba0987a728fca047d1182d7a53a42b1a7
parent7bb768ddab3d7a4d98682f0a74653e3e8c40602c (diff)
downloadastro-e0c3318c09c6d8158e51d09e88eae32bb26f7bb7.tar.gz
astro-e0c3318c09c6d8158e51d09e88eae32bb26f7bb7.tar.zst
astro-e0c3318c09c6d8158e51d09e88eae32bb26f7bb7.zip
Update Astro docs to use v0.21 (#1738)
* update docs site to leverage astro v0.21 * fix resolutions * fix docsearch import * Resolve `@docsearch/react` is a cross-execution-context-friendly way * chore: update astro version * fix: remove line highlighting syntax * fix: braces inside of attr string * Match current astro version * Trim leading newline in MainLayout.astro template * Move card grid styles into Layout Co-authored-by: Nate Moore <nate@skypack.dev>
-rw-r--r--docs/astro.config.mjs13
-rw-r--r--docs/package.json2
-rw-r--r--docs/snowpack.config.mjs8
-rw-r--r--docs/src/components/HeadSEO.astro2
-rw-r--r--docs/src/components/Header/Header.astro4
-rw-r--r--docs/src/components/Header/Search.tsx6
-rw-r--r--docs/src/components/PageContent/PageContent.astro6
-rw-r--r--docs/src/components/RightSidebar/MoreMenu.astro2
-rw-r--r--docs/src/components/RightSidebar/RightSidebar.astro2
-rw-r--r--docs/src/layouts/MainLayout.astro3
-rw-r--r--docs/src/pages/guides/deploy.md2
-rw-r--r--docs/src/pages/themes.astro18
12 files changed, 35 insertions, 33 deletions
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
index d68ce262b..af4fed122 100644
--- a/docs/astro.config.mjs
+++ b/docs/astro.config.mjs
@@ -1,4 +1,5 @@
-export default {
+// @ts-check
+export default /** @type {import('astro').AstroUserConfig} */ ({
buildOptions: {
site: 'https://docs.astro.build/',
},
@@ -8,4 +9,12 @@ export default {
// Needed for Algolia search component
'@astrojs/renderer-react',
],
-};
+ vite: {
+ resolve: {
+ alias: {
+ '~': '/src',
+ 'components': '/src/components',
+ }
+ }
+ }
+})
diff --git a/docs/package.json b/docs/package.json
index cd2e38f68..1272019f6 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -17,7 +17,7 @@
},
"devDependencies": {
"@snowpack/plugin-dotenv": "^2.1.0",
- "astro": "^0.21.0-next.0",
+ "astro": "^0.21.0-next.2",
"broken-link-checker": "^0.7.8",
"npm-run-all": "^4.1.5",
"pa11y-ci": "^2.4.2",
diff --git a/docs/snowpack.config.mjs b/docs/snowpack.config.mjs
deleted file mode 100644
index d1ef58a5f..000000000
--- a/docs/snowpack.config.mjs
+++ /dev/null
@@ -1,8 +0,0 @@
-export default {
- alias: {
- components: './src/components',
- '~': './src',
- },
- plugins: ['@snowpack/plugin-dotenv'],
- workspaceRoot: '../',
-};
diff --git a/docs/src/components/HeadSEO.astro b/docs/src/components/HeadSEO.astro
index 9cc9046a6..d3cd80901 100644
--- a/docs/src/components/HeadSEO.astro
+++ b/docs/src/components/HeadSEO.astro
@@ -19,7 +19,7 @@ const lang = canonicalURL && getLanguageFromURL(canonicalURL.pathname);
<link rel="canonical" href={canonicalURL}/>
<!-- Algolia docsearch language facet -->
-<meta name="docsearch:language" content="{lang}" />
+<meta name="docsearch:language" content={lang} />
<!-- OpenGraph Tags -->
<meta property="og:title" content={content.title ?? SITE.title}/>
diff --git a/docs/src/components/Header/Header.astro b/docs/src/components/Header/Header.astro
index 901075cf4..06954bd7f 100644
--- a/docs/src/components/Header/Header.astro
+++ b/docs/src/components/Header/Header.astro
@@ -1,8 +1,8 @@
---
import SkipToContent from './SkipToContent.astro';
import SidebarToggle from './SidebarToggle.tsx';
-import LanguageSelect from './LanguageSelect.jsx';
-import Search from "./Search.jsx";
+import LanguageSelect from './LanguageSelect.tsx';
+import Search from "./Search.tsx";
import { getLanguageFromURL } from '../../util.ts';
const {currentPage} = Astro.props;
const lang = currentPage && getLanguageFromURL(currentPage);
diff --git a/docs/src/components/Header/Search.tsx b/docs/src/components/Header/Search.tsx
index 7b8532a81..4ca7b4ef1 100644
--- a/docs/src/components/Header/Search.tsx
+++ b/docs/src/components/Header/Search.tsx
@@ -1,10 +1,12 @@
/* jsxImportSource: react */
import { useState, useCallback, useRef } from 'react';
import { createPortal } from 'react-dom';
-import { DocSearchModal, useDocSearchKeyboardEvents } from '@docsearch/react';
-import '@docsearch/css//dist/style.css';
+import * as docsearch from '@docsearch/react';
+import '@docsearch/css/dist/style.css';
import './Search.css';
+const { DocSearchModal, useDocSearchKeyboardEvents } = ((docsearch as unknown as { default: typeof docsearch }).default || docsearch)
+
export default function Search(props) {
const [isOpen, setIsOpen] = useState(false);
const searchButtonRef = useRef();
diff --git a/docs/src/components/PageContent/PageContent.astro b/docs/src/components/PageContent/PageContent.astro
index 0598d7a2f..91ea90d62 100644
--- a/docs/src/components/PageContent/PageContent.astro
+++ b/docs/src/components/PageContent/PageContent.astro
@@ -1,11 +1,11 @@
---
-const {content, githubEditUrl, currentPage} = Astro.props;
-const title = content.title;
-const headers = content.astro?.headers;
import MoreMenu from '../RightSidebar/MoreMenu.astro';
import TableOfContents from '../RightSidebar/TableOfContents.tsx';
import {getLanguageFromURL} from '../../util.ts';
import {SIDEBAR} from '../../config.ts';
+const {content, githubEditUrl, currentPage} = Astro.props;
+const title = content.title;
+const headers = content.astro?.headers;
const langCode = getLanguageFromURL(currentPage);
const links = SIDEBAR[langCode].filter(x => x.link && typeof x.header === 'undefined');
// handle cases with a trailing slash or not
diff --git a/docs/src/components/RightSidebar/MoreMenu.astro b/docs/src/components/RightSidebar/MoreMenu.astro
index 6be2d86ee..6ae8425cc 100644
--- a/docs/src/components/RightSidebar/MoreMenu.astro
+++ b/docs/src/components/RightSidebar/MoreMenu.astro
@@ -1,5 +1,5 @@
---
-import ThemeToggleButton from './ThemeToggleButton.jsx';
+import ThemeToggleButton from './ThemeToggleButton.tsx';
const {editHref} = Astro.props;
---
<style>
diff --git a/docs/src/components/RightSidebar/RightSidebar.astro b/docs/src/components/RightSidebar/RightSidebar.astro
index 04ce66772..5415d4cef 100644
--- a/docs/src/components/RightSidebar/RightSidebar.astro
+++ b/docs/src/components/RightSidebar/RightSidebar.astro
@@ -1,5 +1,5 @@
---
-import TableOfContents from './TableOfContents.jsx';
+import TableOfContents from './TableOfContents.tsx';
import MoreMenu from './MoreMenu.astro';
const {content, githubEditUrl} = Astro.props;
const headers = content.astro?.headers;
diff --git a/docs/src/layouts/MainLayout.astro b/docs/src/layouts/MainLayout.astro
index 2a559d57e..b2302125e 100644
--- a/docs/src/layouts/MainLayout.astro
+++ b/docs/src/layouts/MainLayout.astro
@@ -14,8 +14,7 @@ const currentFile = `src/pages${currentPage.replace(/\/$/, "")}.md`;
const githubEditUrl = `https://github.com/snowpackjs/astro/blob/main/docs/${currentFile}`;
const formatTitle = (content, SITE) => content.title ? `${content.title} 🚀 ${SITE.title}` : SITE.title;
---
-
-<html dir="{content.dir ?? 'ltr'}" lang="{content.lang ?? 'en-us'}" class="initial">
+<html dir={content.dir ?? 'ltr'} lang={content.lang ?? 'en-us'} class="initial">
<head>
<HeadCommon />
<HeadSEO {content} canonicalURL={Astro.request.canonicalURL} />
diff --git a/docs/src/pages/guides/deploy.md b/docs/src/pages/guides/deploy.md
index b89a7fa5f..18bbb12d2 100644
--- a/docs/src/pages/guides/deploy.md
+++ b/docs/src/pages/guides/deploy.md
@@ -37,7 +37,7 @@ By default, the build output will be placed at `dist/`. You may deploy this `dis
1. Set the correct `buildOptions.site` in `astro.config.mjs`.
1. Inside your project, create `deploy.sh` with the following content (uncommenting the appropriate lines), and run it to deploy:
- ```bash{13,20,23}
+ ```bash
#!/usr/bin/env sh
# abort on errors
diff --git a/docs/src/pages/themes.astro b/docs/src/pages/themes.astro
index 3bcc1df48..46ee24cec 100644
--- a/docs/src/pages/themes.astro
+++ b/docs/src/pages/themes.astro
@@ -5,16 +5,16 @@ import {Markdown} from 'astro/components';
import themes from '../data/themes.json';
import components from '../data/components.json';
---
-<style>
- .card-grid {
- display: grid;
- grid-column-gap: 15px;
- grid-row-gap: 15px;
- grid-auto-flow: dense;
- grid-template-columns: repeat(auto-fit,minmax(300px,1fr))
- }
-</style>
<Layout content={{title: 'Themes'}} hideRightSidebar>
+ <style>
+ .card-grid {
+ display: grid;
+ grid-column-gap: 15px;
+ grid-row-gap: 15px;
+ grid-auto-flow: dense;
+ grid-template-columns: repeat(auto-fit,minmax(300px,1fr))
+ }
+ </style>
<Markdown>
## Featured Theme
</Markdown>