diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 4287531b..29f8687a 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -16,6 +16,9 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 + with: + # Full history for the git-based last update dates. + fetch-depth: 0 - uses: actions/setup-node@v3 with: node-version: 22 diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml index cf40d3a3..d41536f5 100644 --- a/.github/workflows/test-deploy.yml +++ b/.github/workflows/test-deploy.yml @@ -13,6 +13,9 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 + with: + # Full history for the git-based last update dates. + fetch-depth: 0 - uses: actions/setup-node@v3 with: node-version: 22 diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md deleted file mode 100644 index 02f3f81b..00000000 --- a/blog/2019-05-28-first-blog-post.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: first-blog-post -title: First Blog Post -authors: - name: Gao Wei - title: Docusaurus Core Team - url: https://github.com/wgao19 - image_url: https://github.com/wgao19.png -tags: [hola, docusaurus] ---- - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md deleted file mode 100644 index 26ffb1b1..00000000 --- a/blog/2019-05-29-long-blog-post.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: long-blog-post -title: Long Blog Post -authors: endi -tags: [hello, docusaurus] ---- - -This is the summary of a very long blog post, - -Use a `` comment to limit blog post size in the list view. - - - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx deleted file mode 100644 index c04ebe32..00000000 --- a/blog/2021-08-01-mdx-blog-post.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -slug: mdx-blog-post -title: MDX Blog Post -authors: [slorber] -tags: [docusaurus] ---- - -Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/). - -:::tip - -Use the power of React to create interactive blog posts. - -```js - -``` - - - -::: diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg deleted file mode 100644 index 11bda092..00000000 Binary files a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg and /dev/null differ diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md deleted file mode 100644 index 9455168f..00000000 --- a/blog/2021-08-26-welcome/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -slug: welcome -title: Welcome -authors: [slorber, yangshun] -tags: [facebook, hello, docusaurus] ---- - -[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog). - -Simply add Markdown files (or folders) to the `blog` directory. - -Regular blog authors can be added to `authors.yml`. - -The blog post date can be extracted from filenames, such as: - -- `2019-05-30-welcome.md` -- `2019-05-30-welcome/index.md` - -A blog post folder can be convenient to co-locate blog post images: - -![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg) - -The blog supports tags as well! - -**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config. diff --git a/blog/authors.yml b/blog/authors.yml deleted file mode 100644 index bcb29915..00000000 --- a/blog/authors.yml +++ /dev/null @@ -1,17 +0,0 @@ -endi: - name: Endilie Yacop Sucipto - title: Maintainer of Docusaurus - url: https://github.com/endiliey - image_url: https://github.com/endiliey.png - -yangshun: - name: Yangshun Tay - title: Front End Engineer @ Facebook - url: https://github.com/yangshun - image_url: https://github.com/yangshun.png - -slorber: - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png diff --git a/docs/install.md b/docs/install.md index 475530d7..6e4697d5 100644 --- a/docs/install.md +++ b/docs/install.md @@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem'; :::tip Need turn-by-turn navigation? See [turn-by-turn navigation with @rnmapbox/navigation](navigation/overview.md), built on `@rnmapbox/maps`. ::: -# Configure credentials +## Configure credentials Before installing @rnmapbox/maps you'll need to get your Mapbox access token. @@ -22,7 +22,7 @@ On the top of your token list, copy your **Default Public Token**. The public to For more details, see [Configure Credentials](https://docs.mapbox.com/ios/maps/guides/install/#part-1-create-and-configure-your-credentials) on mapbox.com. -# Install +## Install -# Configure @rnmapbox/maps +## Configure @rnmapbox/maps -# Configure @rnmapbox/navigation +## Configure @rnmapbox/navigation -# Access token +## Access token Pass your public access token to both libraries before requesting routes. Navigation is billed to this token. diff --git a/docusaurus.config.js b/docusaurus.config.js index 0b68a98e..683dba65 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -66,6 +66,7 @@ const config = { ({ docs: { sidebarPath: require.resolve('./sidebars.js'), + showLastUpdateTime: true, editUrl: (url) => { if (url.docPath.startsWith('examples/')) { return `https://github.com/rnmapbox/maps/tree/main/example/src/examples/${url.docPath.replace('examples/', '').replace('.md', '.tsx')}` @@ -78,12 +79,14 @@ const config = { } } }, + blog: false, theme: { customCss: require.resolve('./src/css/custom.css'), }, sitemap: { - // The blog and the markdown page are still the Docusaurus template content, and search is noindex. - ignorePatterns: ['/blog', '/blog/**', '/markdown-page', '/search'], + lastmod: 'date', + // Search and the tag pages are noindex. + ignorePatterns: ['/search', '/docs/tags', '/docs/tags/**'], }, }), ], diff --git a/src/pages/markdown-page.md b/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b6..00000000 --- a/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. diff --git a/src/theme/DocItem/Metadata/index.js b/src/theme/DocItem/Metadata/index.js new file mode 100644 index 00000000..fe09ea49 --- /dev/null +++ b/src/theme/DocItem/Metadata/index.js @@ -0,0 +1,37 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import {PageMetadata} from '@docusaurus/theme-common'; +import {useDoc} from '@docusaurus/plugin-content-docs/client'; +import Metadata from '@theme-original/DocItem/Metadata'; + +const NAVIGATION_PACKAGE = '@rnmapbox/navigation'; + +function NavigationMetadata() { + const {metadata, frontMatter, assets} = useDoc(); + const {siteConfig} = useDocusaurusContext(); + const title = metadata.title.includes(NAVIGATION_PACKAGE) + ? metadata.title + : `${metadata.title} ${siteConfig.titleDelimiter} ${NAVIGATION_PACKAGE}`; + return ( + <> + + + {title} + + + + ); +} + +export default function MetadataWrapper(props) { + const {metadata} = useDoc(); + return ( + <> + + {metadata.permalink.startsWith('/docs/navigation/') && } + + ); +} diff --git a/src/theme/DocTagDocListPage/index.js b/src/theme/DocTagDocListPage/index.js new file mode 100644 index 00000000..da7e8c05 --- /dev/null +++ b/src/theme/DocTagDocListPage/index.js @@ -0,0 +1,14 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; +import Original from '@theme-original/DocTagDocListPage'; + +export default function DocTagDocListPageWrapper(props) { + return ( + <> + + + + + + ); +} diff --git a/src/theme/DocTagsListPage/index.js b/src/theme/DocTagsListPage/index.js new file mode 100644 index 00000000..c6d45ddc --- /dev/null +++ b/src/theme/DocTagsListPage/index.js @@ -0,0 +1,14 @@ +import React from 'react'; +import Head from '@docusaurus/Head'; +import Original from '@theme-original/DocTagsListPage'; + +export default function DocTagsListPageWrapper(props) { + return ( + <> + + + + + + ); +}