From e0c3318c09c6d8158e51d09e88eae32bb26f7bb7 Mon Sep 17 00:00:00 2001 From: Jonathan Neal Date: Thu, 11 Nov 2021 12:09:48 -0500 Subject: [PATCH] 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 --- docs/astro.config.mjs | 13 +++++++++++-- docs/package.json | 2 +- docs/snowpack.config.mjs | 8 -------- docs/src/components/HeadSEO.astro | 2 +- docs/src/components/Header/Header.astro | 4 ++-- docs/src/components/Header/Search.tsx | 6 ++++-- .../components/PageContent/PageContent.astro | 6 +++--- .../src/components/RightSidebar/MoreMenu.astro | 2 +- .../components/RightSidebar/RightSidebar.astro | 2 +- docs/src/layouts/MainLayout.astro | 3 +-- docs/src/pages/guides/deploy.md | 2 +- docs/src/pages/themes.astro | 18 +++++++++--------- 12 files changed, 35 insertions(+), 33 deletions(-) delete mode 100644 docs/snowpack.config.mjs diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index d68ce262b0..af4fed122b 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 cd2e38f687..1272019f63 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 d1ef58a5ff..0000000000 --- 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 9cc9046a6b..d3cd80901d 100644 --- a/docs/src/components/HeadSEO.astro +++ b/docs/src/components/HeadSEO.astro @@ -19,7 +19,7 @@ const lang = canonicalURL && getLanguageFromURL(canonicalURL.pathname); - + diff --git a/docs/src/components/Header/Header.astro b/docs/src/components/Header/Header.astro index 901075cf42..06954bd7f1 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 7b8532a816..4ca7b4ef12 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 0598d7a2fa..91ea90d622 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 6be2d86ee5..6ae8425ccf 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; --- + ## Featured Theme