diff --git a/docs/tutorial-basics/_category_.json b/docs/docs-basics/_category_.json similarity index 82% rename from docs/tutorial-basics/_category_.json rename to docs/docs-basics/_category_.json index 2e6db55..1bd64c4 100644 --- a/docs/tutorial-basics/_category_.json +++ b/docs/docs-basics/_category_.json @@ -1,5 +1,5 @@ { - "label": "Tutorial - Basics", + "label": "Docs - Basics", "position": 2, "link": { "type": "generated-index", diff --git a/docs/tutorial-basics/congratulations.md b/docs/docs-basics/congratulations.md similarity index 73% rename from docs/tutorial-basics/congratulations.md rename to docs/docs-basics/congratulations.md index 04771a0..80a45ea 100644 --- a/docs/tutorial-basics/congratulations.md +++ b/docs/docs-basics/congratulations.md @@ -8,9 +8,9 @@ You have just learned the **basics of Docusaurus** and made some changes to the Docusaurus has **much more to offer**! -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. +Have **5 more minutes**? Take a look at **[versioning](../docs-extras/manage-docs-versions.md)** and **[i18n](../docs-extras/translate-your-site.md)**. -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) +Anything **unclear** or **buggy** in this docs? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) ## What's next? diff --git a/docs/tutorial-basics/create-a-blog-post.md b/docs/docs-basics/create-a-blog-post.md similarity index 100% rename from docs/tutorial-basics/create-a-blog-post.md rename to docs/docs-basics/create-a-blog-post.md diff --git a/docs/tutorial-basics/create-a-document.md b/docs/docs-basics/create-a-document.md similarity index 90% rename from docs/tutorial-basics/create-a-document.md rename to docs/docs-basics/create-a-document.md index c22fe29..86c3199 100644 --- a/docs/tutorial-basics/create-a-document.md +++ b/docs/docs-basics/create-a-document.md @@ -43,14 +43,14 @@ It is also possible to create your sidebar explicitly in `sidebars.js`: ```js title="sidebars.js" export default { - tutorialSidebar: [ + docsSidebar: [ 'intro', // highlight-next-line 'hello', { type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], + label: 'Intro', + items: ['docs-basics/create-a-document'], }, ], }; diff --git a/docs/tutorial-basics/create-a-page.md b/docs/docs-basics/create-a-page.md similarity index 100% rename from docs/tutorial-basics/create-a-page.md rename to docs/docs-basics/create-a-page.md diff --git a/docs/tutorial-basics/deploy-your-site.md b/docs/docs-basics/deploy-your-site.md similarity index 100% rename from docs/tutorial-basics/deploy-your-site.md rename to docs/docs-basics/deploy-your-site.md diff --git a/docs/tutorial-basics/markdown-features.mdx b/docs/docs-basics/markdown-features.mdx similarity index 100% rename from docs/tutorial-basics/markdown-features.mdx rename to docs/docs-basics/markdown-features.mdx diff --git a/docs/tutorial-extras/_category_.json b/docs/docs-extras/_category_.json similarity index 67% rename from docs/tutorial-extras/_category_.json rename to docs/docs-extras/_category_.json index a8ffcc1..5897486 100644 --- a/docs/tutorial-extras/_category_.json +++ b/docs/docs-extras/_category_.json @@ -1,5 +1,5 @@ { - "label": "Tutorial - Extras", + "label": "Docs - Extras", "position": 3, "link": { "type": "generated-index" diff --git a/docs/tutorial-extras/img/docsVersionDropdown.png b/docs/docs-extras/img/docsVersionDropdown.png similarity index 100% rename from docs/tutorial-extras/img/docsVersionDropdown.png rename to docs/docs-extras/img/docsVersionDropdown.png diff --git a/docs/tutorial-extras/img/localeDropdown.png b/docs/docs-extras/img/localeDropdown.png similarity index 100% rename from docs/tutorial-extras/img/localeDropdown.png rename to docs/docs-extras/img/localeDropdown.png diff --git a/docs/tutorial-extras/manage-docs-versions.md b/docs/docs-extras/manage-docs-versions.md similarity index 100% rename from docs/tutorial-extras/manage-docs-versions.md rename to docs/docs-extras/manage-docs-versions.md diff --git a/docs/tutorial-extras/translate-your-site.md b/docs/docs-extras/translate-your-site.md similarity index 100% rename from docs/tutorial-extras/translate-your-site.md rename to docs/docs-extras/translate-your-site.md diff --git a/docs/intro.md b/docs/intro.md index 45e8604..df090c7 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -1,8 +1,9 @@ --- sidebar_position: 1 +slug: / --- -# Tutorial Intro +# Docs Intro Let's discover **Docusaurus in less than 5 minutes**. diff --git a/docusaurus.config.ts b/docusaurus.config.ts index ecfddde..9491f8a 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -62,21 +62,7 @@ const config: Config = { editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', }, - blog: { - showReadingTime: true, - feedOptions: { - type: ['rss', 'atom'], - xslt: true, - }, - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', - // Useful options to enforce blogging best practices - onInlineTags: 'warn', - onInlineAuthors: 'warn', - onUntruncatedBlogPosts: 'warn', - }, + blog: false, theme: { customCss: './src/css/custom.css', }, @@ -99,20 +85,14 @@ const config: Config = { src: 'img/454826088-5175d00c-1fb9-4efb-a158-b405f91af8d0.png', srcDark: 'img/454826087-c3cb9dfc-9d13-4460-8c3c-bb61ff134e55.png', }, - items: [ - { - type: 'docSidebar', - sidebarId: 'tutorialSidebar', - position: 'left', - label: 'Tutorial', - }, - {to: '/blog', label: 'Blog', position: 'left'}, - { - href: 'https://github.com/facebook/docusaurus', - label: 'GitHub', - position: 'right', - }, - ], + items: [ + { + type: 'doc', + docId: 'intro', + position: 'left', + label: 'Docs', + }, + ], }, footer: { style: 'dark', @@ -121,8 +101,8 @@ const config: Config = { title: 'Docs', items: [ { - label: 'Tutorial', - to: '/intro', + label: 'Docs', + to: '/', }, ], }, @@ -146,10 +126,6 @@ const config: Config = { { title: 'More', items: [ - { - label: 'Blog', - to: '/blog', - }, { label: 'GitHub', href: 'https://github.com/facebook/docusaurus', diff --git a/package.json b/package.json index b5384f6..a11d3e5 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ }, "dependencies": { "@docusaurus/core": "3.8.1", + "@docusaurus/plugin-client-redirects": "^3.8.1", "@docusaurus/preset-classic": "3.8.1", "@easyops-cn/docusaurus-search-local": "^0.51.0", "@mdx-js/react": "^3.0.0", diff --git a/sidebars.ts b/sidebars.ts index 2897139..b8fd902 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -14,17 +14,17 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; */ const sidebars: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + docsSidebar: [{type: 'autogenerated', dirName: '.'}], // But you can create a sidebar manually /* - tutorialSidebar: [ + docsSidebar: [ 'intro', 'hello', { type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], + label: 'Docs', + items: ['docs-basics/create-a-document'], }, ], */ diff --git a/src/css/custom.css b/src/css/custom.css index 66dab4b..f40c8b4 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -28,4 +28,5 @@ --ifm-color-primary-lightest: #4fddbf; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); --ifm-background-color: #232734; + --ifm-navbar-background-color: var(--ifm-background-color); } diff --git a/src/pages/index.tsx b/src/pages/index.tsx deleted file mode 100644 index 88d9310..0000000 --- a/src/pages/index.tsx +++ /dev/null @@ -1,44 +0,0 @@ -import type {ReactNode} from 'react'; -import clsx from 'clsx'; -import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; -import Heading from '@theme/Heading'; - -import styles from './index.module.css'; - -function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); - return ( -
-
- - {siteConfig.title} - -

{siteConfig.tagline}

-
- - Docusaurus Tutorial - 5min ⏱️ - -
-
-
- ); -} - -export default function Home(): ReactNode { - const {siteConfig} = useDocusaurusContext(); - return ( - - -
- -
- - ); -} diff --git a/yarn.lock b/yarn.lock index 0d85a14..e1086c5 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1561,6 +1561,21 @@ react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" react-loadable "npm:@docusaurus/react-loadable@6.0.0" +"@docusaurus/plugin-client-redirects@^3.8.1": + version "3.8.1" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-3.8.1.tgz#1d02b3565ae4e53a3b8005835501f07fb0bc0267" + integrity sha512-F+86R7PBn6VNgy/Ux8w3ZRypJGJEzksbejQKlbTC8u6uhBUhfdXWkDp6qdOisIoW0buY5nLqucvZt1zNJzhJhA== + dependencies: + "@docusaurus/core" "3.8.1" + "@docusaurus/logger" "3.8.1" + "@docusaurus/utils" "3.8.1" + "@docusaurus/utils-common" "3.8.1" + "@docusaurus/utils-validation" "3.8.1" + eta "^2.2.0" + fs-extra "^11.1.1" + lodash "^4.17.21" + tslib "^2.6.0" + "@docusaurus/plugin-content-blog@3.8.1": version "3.8.1" resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.8.1.tgz#88d842b562b04cf59df900d9f6984b086f821525"