diff --git a/.changeset/hide-mean-turkeys.md b/.changeset/hide-mean-turkeys.md new file mode 100644 index 0000000..d6af9ed --- /dev/null +++ b/.changeset/hide-mean-turkeys.md @@ -0,0 +1,5 @@ +--- +'@primer/doctocat-nextjs': patch +--- + +Added OpenGraph tags for improved social sharing experience. diff --git a/.changeset/mean-turkeys-hide.md b/.changeset/mean-turkeys-hide.md new file mode 100644 index 0000000..a8cae9f --- /dev/null +++ b/.changeset/mean-turkeys-hide.md @@ -0,0 +1,31 @@ +--- +'@primer/doctocat-nextjs': patch +--- + +Enabled related content navigation using `keywords` and `related` properties in Markdown frontmatter. + +Example: + +``` +--- +title: Page A +keywords: ['keyword', 'another keyword'] +--- +``` + +``` +--- +title: Page B +keywords: ['keyword', 'another keyword'] +--- +``` + +The matching keyword values above across both pages, will enable automatic related content navigation between the two pages. + +or using the `related` property: + +``` +--- +related: [{title: External link example, href: https://example.com}] +--- +``` diff --git a/.changeset/turkeys-mean-hide.md b/.changeset/turkeys-mean-hide.md new file mode 100644 index 0000000..6f12748 --- /dev/null +++ b/.changeset/turkeys-mean-hide.md @@ -0,0 +1,5 @@ +--- +'@primer/doctocat-nextjs': patch +--- + +Fixed accessibility violations arising from duplicate landmarks and missing aria labels. diff --git a/.github/workflows/release_canary.yml b/.github/workflows/release_canary.yml index c188888..7d5b0c5 100644 --- a/.github/workflows/release_canary.yml +++ b/.github/workflows/release_canary.yml @@ -9,8 +9,7 @@ on: jobs: release-canary: - if: false - #if: ${{ github.repository == 'primer/doctocat-nextjs' }} + if: ${{ github.repository == 'primer/doctocat-nextjs' }} name: Canary runs-on: ubuntu-latest steps: diff --git a/packages/site/pages/content-examples/kitchen-sink.mdx b/packages/site/pages/content-examples/kitchen-sink.mdx index c154fd6..eabac88 100644 --- a/packages/site/pages/content-examples/kitchen-sink.mdx +++ b/packages/site/pages/content-examples/kitchen-sink.mdx @@ -7,6 +7,8 @@ action-1-text: Primary action action-1-link: / action-2-text: Secondary action action-2-link: /content-examples/kitchen-sink +keywords: ['accessibility', 'introduction', 'simple'] +related: [{title: External link example, href: https://primer.style}] --- import {DoDontContainer, Do, Dont, Caption} from '@primer/doctocat-nextjs' diff --git a/packages/site/pages/content-examples/simple.mdx b/packages/site/pages/content-examples/simple.mdx index 25d2543..497fb69 100644 --- a/packages/site/pages/content-examples/simple.mdx +++ b/packages/site/pages/content-examples/simple.mdx @@ -1,6 +1,7 @@ --- title: Simple description: A simple page with plain markdown +keywords: ['kitchen sink', 'introduction', 'simple'] --- ## Arva qua ferarum victa diff --git a/packages/site/pages/getting-started/introduction.mdx b/packages/site/pages/getting-started/introduction.mdx index d4b286b..8c8f9a0 100644 --- a/packages/site/pages/getting-started/introduction.mdx +++ b/packages/site/pages/getting-started/introduction.mdx @@ -1,6 +1,7 @@ --- title: Introduction description: Learn how to create a new site with Doctocat +keywords: ['accessibility', 'introduction', 'simple'] --- This guide will walk you through creating, customizing, and deploying a new documentation site powered by Doctocat on [Next.js](https://nextjs.org/). diff --git a/packages/theme/components/layout/header/Header.tsx b/packages/theme/components/layout/header/Header.tsx index 5913ca5..4e98e33 100644 --- a/packages/theme/components/layout/header/Header.tsx +++ b/packages/theme/components/layout/header/Header.tsx @@ -163,7 +163,11 @@ export function Header({pageMap, docsDirectories, siteTitle}: HeaderProps) { }, []) return ( -