diff options
author | Kristóf Marussy <kristof@marussy.com> | 2024-03-23 18:02:45 +0100 |
---|---|---|
committer | Kristóf Marussy <kristof@marussy.com> | 2024-03-23 18:07:21 +0100 |
commit | fbd41d395916176dde11bb0e417f1210f34eb4ab (patch) | |
tree | 7384a50b1a90ba5909d8f93f589df661640681e6 /src/theme | |
parent | Simplify compression (diff) | |
download | blog-fbd41d395916176dde11bb0e417f1210f34eb4ab.tar.gz blog-fbd41d395916176dde11bb0e417f1210f34eb4ab.tar.zst blog-fbd41d395916176dde11bb0e417f1210f34eb4ab.zip |
Add blog
Site structure follows SEO tips from
https://johnnyreilly.com/how-we-fixed-my-seo
* The blog pages have as simple of an URL as possible. To this end, the home
page of the site is actually the first index page of the blog.
* Customize the blog index page BlogListPage component to show the landing page
as the first index page.
* Rename /archive to /blog to avoid a dated feel.
* Remove the date from post URLs using the slug property.
Diffstat (limited to 'src/theme')
-rw-r--r-- | src/theme/BlogListPage.tsx | 18 | ||||
-rw-r--r-- | src/theme/BlogSidebar/Desktop.module.css | 53 | ||||
-rw-r--r-- | src/theme/BlogSidebar/Desktop.tsx | 55 | ||||
-rw-r--r-- | src/theme/Footer/Copyright.tsx (renamed from src/theme/Footer/Copyright.jsx) | 5 | ||||
-rw-r--r-- | src/theme/NavbarItem/NavbarNavLink.tsx (renamed from src/theme/NavbarItem/NavbarNavLink.jsx) | 4 | ||||
-rw-r--r-- | src/theme/PaginatorNavLink.tsx | 17 | ||||
-rw-r--r-- | src/theme/Root.tsx | 11 | ||||
-rw-r--r-- | src/theme/SiteMetadata.jsx | 28 |
8 files changed, 160 insertions, 31 deletions
diff --git a/src/theme/BlogListPage.tsx b/src/theme/BlogListPage.tsx new file mode 100644 index 0000000..b8c7e01 --- /dev/null +++ b/src/theme/BlogListPage.tsx | |||
@@ -0,0 +1,18 @@ | |||
1 | /* | ||
2 | * SPDX-FileCopyrightText: 2024 Kristóf Marussy | ||
3 | * | ||
4 | * SPDX-License-Identifier: MIT | ||
5 | */ | ||
6 | |||
7 | import React from 'react'; | ||
8 | import type { Props } from '@theme/BlogListPage'; | ||
9 | import BlogListPage from '@theme-original/BlogListPage'; | ||
10 | |||
11 | import Landing from '@site/src/components/Landing'; | ||
12 | |||
13 | export default function BlogListPageWrapper(props: Props) { | ||
14 | if (props.metadata.permalink === '/') { | ||
15 | return <Landing {...props} />; | ||
16 | } | ||
17 | return <BlogListPage {...props} />; | ||
18 | } | ||
diff --git a/src/theme/BlogSidebar/Desktop.module.css b/src/theme/BlogSidebar/Desktop.module.css new file mode 100644 index 0000000..4bac5ba --- /dev/null +++ b/src/theme/BlogSidebar/Desktop.module.css | |||
@@ -0,0 +1,53 @@ | |||
1 | /* | ||
2 | * Copyright (c) Facebook, Inc. and its affiliates. | ||
3 | * Copyright (c) 2024 Kristóf Marussy <kristof@marussy.com> | ||
4 | * | ||
5 | * SPDX-License-Identifier: MIT | ||
6 | * | ||
7 | * This file was derived from | ||
8 | * https://github.com/facebook/docusaurus/blob/6f17d5493877ba38d8b4e0b0d468f44401375c30/packages/docusaurus-theme-classic/src/theme/BlogSidebar/Desktop/styles.module.css | ||
9 | * via the `swizzle` mechanism of Docusaurus. | ||
10 | * | ||
11 | * It was modified to change the sidebar title styling. | ||
12 | */ | ||
13 | |||
14 | .sidebar { | ||
15 | max-height: calc(100vh - (var(--ifm-navbar-height) + 2rem)); | ||
16 | overflow-y: auto; | ||
17 | position: sticky; | ||
18 | top: calc(var(--ifm-navbar-height) + 2rem); | ||
19 | } | ||
20 | |||
21 | .sidebarItemTitle { | ||
22 | font-size: 1.5rem; | ||
23 | font-weight: var(--ifm-font-weight-bold); | ||
24 | --casl: 1; | ||
25 | letter-spacing: var(--marussy-heading-tracking); | ||
26 | } | ||
27 | |||
28 | .sidebarItemList { | ||
29 | font-size: 0.9rem; | ||
30 | } | ||
31 | |||
32 | .sidebarItem { | ||
33 | margin-top: 0.7rem; | ||
34 | } | ||
35 | |||
36 | .sidebarItemLink { | ||
37 | color: var(--ifm-font-color-base); | ||
38 | display: block; | ||
39 | } | ||
40 | |||
41 | .sidebarItemLink:hover { | ||
42 | text-decoration: none; | ||
43 | } | ||
44 | |||
45 | .sidebarItemLinkActive { | ||
46 | color: var(--ifm-color-primary) !important; | ||
47 | } | ||
48 | |||
49 | @media (max-width: 996px) { | ||
50 | .sidebar { | ||
51 | display: none; | ||
52 | } | ||
53 | } | ||
diff --git a/src/theme/BlogSidebar/Desktop.tsx b/src/theme/BlogSidebar/Desktop.tsx new file mode 100644 index 0000000..d06f239 --- /dev/null +++ b/src/theme/BlogSidebar/Desktop.tsx | |||
@@ -0,0 +1,55 @@ | |||
1 | /* | ||
2 | * Copyright (c) Facebook, Inc. and its affiliates. | ||
3 | * Copyright (c) 2024 Kristóf Marussy <kristof@marussy.com> | ||
4 | * | ||
5 | * SPDX-License-Identifier: MIT | ||
6 | * | ||
7 | * This file was derived from | ||
8 | * https://github.com/facebook/docusaurus/blob/6f17d5493877ba38d8b4e0b0d468f44401375c30/packages/docusaurus-theme-classic/src/theme/BlogSidebar/Desktop/index.tsx | ||
9 | * via the `swizzle` mechanism of Docusaurus. | ||
10 | * | ||
11 | * It was modified to change the sidebar title styling. | ||
12 | */ | ||
13 | |||
14 | import Link from '@docusaurus/Link'; | ||
15 | import { translate } from '@docusaurus/Translate'; | ||
16 | import { useVisibleBlogSidebarItems } from '@docusaurus/theme-common/internal'; | ||
17 | import type { Props } from '@theme/BlogSidebar/Desktop'; | ||
18 | import React from 'react'; | ||
19 | import clsx from 'clsx'; | ||
20 | |||
21 | import styles from './Desktop.module.css'; | ||
22 | |||
23 | export default function BlogSidebarDesktop({ sidebar }: Props) { | ||
24 | const items = useVisibleBlogSidebarItems(sidebar.items); | ||
25 | return ( | ||
26 | <aside className="col col--3"> | ||
27 | <nav | ||
28 | className={clsx(styles.sidebar, 'thin-scrollbar')} | ||
29 | aria-label={translate({ | ||
30 | id: 'theme.blog.sidebar.navAriaLabel', | ||
31 | message: 'Blog recent posts navigation', | ||
32 | description: 'The ARIA label for recent posts in the blog sidebar', | ||
33 | })} | ||
34 | > | ||
35 | <div className={clsx(styles.sidebarItemTitle, 'margin-bottom--md')}> | ||
36 | <span aria-hidden="true">🗓️</span> {sidebar.title} | ||
37 | </div> | ||
38 | <ul className={clsx(styles.sidebarItemList, 'clean-list')}> | ||
39 | {items.map((item) => ( | ||
40 | <li key={item.permalink} className={styles.sidebarItem}> | ||
41 | <Link | ||
42 | isNavLink | ||
43 | to={item.permalink} | ||
44 | className={styles.sidebarItemLink} | ||
45 | activeClassName={styles.sidebarItemLinkActive} | ||
46 | > | ||
47 | {item.title} | ||
48 | </Link> | ||
49 | </li> | ||
50 | ))} | ||
51 | </ul> | ||
52 | </nav> | ||
53 | </aside> | ||
54 | ); | ||
55 | } | ||
diff --git a/src/theme/Footer/Copyright.jsx b/src/theme/Footer/Copyright.tsx index 648bd42..3125c05 100644 --- a/src/theme/Footer/Copyright.jsx +++ b/src/theme/Footer/Copyright.tsx | |||
@@ -5,13 +5,14 @@ | |||
5 | * SPDX-License-Identifier: MIT | 5 | * SPDX-License-Identifier: MIT |
6 | * | 6 | * |
7 | * This file was derived from | 7 | * This file was derived from |
8 | * https://github.com/facebook/docusaurus/blob/c745021b01a8b88d34e1d772278d7171ad8acdf5/packages/docusaurus-theme-classic/src/theme/Footer/Copyright/index.tsx | 8 | * https://github.com/facebook/docusaurus/blob/cc0bceab9c1678303f6237f5526753edc1b12fc3/packages/docusaurus-theme-classic/src/theme/Footer/Copyright/index.tsx |
9 | * via the `swizzle` mechanism of Docusaurus. | 9 | * via the `swizzle` mechanism of Docusaurus. |
10 | * | 10 | * |
11 | * It was modified to embed JSX content directly in the footer. | 11 | * It was modified to embed JSX content directly in the footer. |
12 | */ | 12 | */ |
13 | 13 | ||
14 | import Link from '@docusaurus/Link'; | 14 | import Link from '@docusaurus/Link'; |
15 | import type { Props } from '@theme/Footer/Copyright'; | ||
15 | import clsx from 'clsx'; | 16 | import clsx from 'clsx'; |
16 | import React from 'react'; | 17 | import React from 'react'; |
17 | 18 | ||
@@ -19,7 +20,7 @@ import { CCLicenseLink, LicenseLink } from '@site/src/components/licenses'; | |||
19 | 20 | ||
20 | import styles from './Copyright.module.css'; | 21 | import styles from './Copyright.module.css'; |
21 | 22 | ||
22 | export default function FooterCopyright({ copyright }) { | 23 | export default function FooterCopyright({ copyright }: Props) { |
23 | return ( | 24 | return ( |
24 | <div className="footer__copyright"> | 25 | <div className="footer__copyright"> |
25 | Most content on this site is{' '} | 26 | Most content on this site is{' '} |
diff --git a/src/theme/NavbarItem/NavbarNavLink.jsx b/src/theme/NavbarItem/NavbarNavLink.tsx index 81de931..a9d7b04 100644 --- a/src/theme/NavbarItem/NavbarNavLink.jsx +++ b/src/theme/NavbarItem/NavbarNavLink.tsx | |||
@@ -18,6 +18,8 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; | |||
18 | import isInternalUrl from '@docusaurus/isInternalUrl'; | 18 | import isInternalUrl from '@docusaurus/isInternalUrl'; |
19 | import { isRegexpStringMatch } from '@docusaurus/theme-common'; | 19 | import { isRegexpStringMatch } from '@docusaurus/theme-common'; |
20 | import IconExternalLink from '@theme/Icon/ExternalLink'; | 20 | import IconExternalLink from '@theme/Icon/ExternalLink'; |
21 | import type { Props } from '@theme/NavbarItem/NavbarNavLink'; | ||
22 | |||
21 | import { useActiveSection } from '@site/src/components/ActiveSectionProvider'; | 23 | import { useActiveSection } from '@site/src/components/ActiveSectionProvider'; |
22 | 24 | ||
23 | export default function NavbarNavLink({ | 25 | export default function NavbarNavLink({ |
@@ -30,7 +32,7 @@ export default function NavbarNavLink({ | |||
30 | isDropdownLink, | 32 | isDropdownLink, |
31 | prependBaseUrlToHref, | 33 | prependBaseUrlToHref, |
32 | ...props | 34 | ...props |
33 | }) { | 35 | }: Props) { |
34 | const { hash: activeSectionHash } = useActiveSection(); | 36 | const { hash: activeSectionHash } = useActiveSection(); |
35 | // TODO all this seems hacky | 37 | // TODO all this seems hacky |
36 | // {to: 'version'} should probably be forbidden, in favor of {to: '/version'} | 38 | // {to: 'version'} should probably be forbidden, in favor of {to: '/version'} |
diff --git a/src/theme/PaginatorNavLink.tsx b/src/theme/PaginatorNavLink.tsx new file mode 100644 index 0000000..d0f03f7 --- /dev/null +++ b/src/theme/PaginatorNavLink.tsx | |||
@@ -0,0 +1,17 @@ | |||
1 | /* | ||
2 | * SPDX-FileCopyrightText: 2024 Kristóf Marussy | ||
3 | * | ||
4 | * SPDX-License-Identifier: MIT | ||
5 | */ | ||
6 | |||
7 | import React from 'react'; | ||
8 | import type { Props } from '@theme/PaginatorNavLink'; | ||
9 | import PaginatorNavLink from '@theme-original/PaginatorNavLink'; | ||
10 | |||
11 | export default function PaginatorNavLinkWrapper(props: Props) { | ||
12 | const modifiedProps = { ...props }; | ||
13 | if (modifiedProps.permalink === '/') { | ||
14 | modifiedProps.permalink = '/#blog'; | ||
15 | } | ||
16 | return <PaginatorNavLink {...modifiedProps} />; | ||
17 | } | ||
diff --git a/src/theme/Root.tsx b/src/theme/Root.tsx index 9459e9f..32462bb 100644 --- a/src/theme/Root.tsx +++ b/src/theme/Root.tsx | |||
@@ -4,14 +4,25 @@ | |||
4 | * SPDX-License-Identifier: MIT | 4 | * SPDX-License-Identifier: MIT |
5 | */ | 5 | */ |
6 | 6 | ||
7 | import Head from '@docusaurus/Head'; | ||
7 | import type { Props } from '@theme/Root'; | 8 | import type { Props } from '@theme/Root'; |
8 | import Root from '@theme-original/Root'; | 9 | import Root from '@theme-original/Root'; |
9 | 10 | ||
10 | import ActiveSectionProvider from '@site/src/components/ActiveSectionProvider'; | 11 | import ActiveSectionProvider from '@site/src/components/ActiveSectionProvider'; |
12 | import fontURL from '@site/src/fonts/recursive-latin.woff2?url'; | ||
11 | 13 | ||
12 | export default function RootWrapper(props: Props) { | 14 | export default function RootWrapper(props: Props) { |
13 | return ( | 15 | return ( |
14 | <ActiveSectionProvider> | 16 | <ActiveSectionProvider> |
17 | <Head> | ||
18 | <link | ||
19 | rel="preload" | ||
20 | href={fontURL} | ||
21 | as="font" | ||
22 | type="font/woff2" | ||
23 | crossOrigin="anonymous" | ||
24 | /> | ||
25 | </Head> | ||
15 | <Root {...props} /> | 26 | <Root {...props} /> |
16 | </ActiveSectionProvider> | 27 | </ActiveSectionProvider> |
17 | ); | 28 | ); |
diff --git a/src/theme/SiteMetadata.jsx b/src/theme/SiteMetadata.jsx deleted file mode 100644 index 1639677..0000000 --- a/src/theme/SiteMetadata.jsx +++ /dev/null | |||
@@ -1,28 +0,0 @@ | |||
1 | /* | ||
2 | * SPDX-FileCopyrightText: 2024 Kristóf Marussy | ||
3 | * | ||
4 | * SPDX-License-Identifier: MIT | ||
5 | */ | ||
6 | |||
7 | import Head from '@docusaurus/Head'; | ||
8 | |||
9 | import SiteMetadata from '@theme-original/SiteMetadata'; | ||
10 | |||
11 | import fontURL from '@site/src/fonts/recursive-latin.woff2?url'; | ||
12 | |||
13 | export default function SiteMetadataWrapper(props) { | ||
14 | return ( | ||
15 | <> | ||
16 | <Head> | ||
17 | <link | ||
18 | rel="preload" | ||
19 | href={fontURL} | ||
20 | as="font" | ||
21 | type="font/woff2" | ||
22 | crossOrigin="anonymous" | ||
23 | /> | ||
24 | </Head> | ||
25 | <SiteMetadata {...props} /> | ||
26 | </> | ||
27 | ); | ||
28 | } | ||