Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Tutorial - Basics",
"label": "Docs - Basics",
"position": 2,
"link": {
"type": "generated-index",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'],
},
],
};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Tutorial - Extras",
"label": "Docs - Extras",
"position": 3,
"link": {
"type": "generated-index"
Expand Down
3 changes: 2 additions & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
sidebar_position: 1
slug: /
---

# Tutorial Intro
# Docs Intro

Let's discover **Docusaurus in less than 5 minutes**.

Expand Down
46 changes: 11 additions & 35 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
},
Expand All @@ -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',
Expand All @@ -121,8 +101,8 @@ const config: Config = {
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/intro',
label: 'Docs',
to: '/',
},
],
},
Expand All @@ -146,10 +126,6 @@ const config: Config = {
{
title: 'More',
items: [
{
label: 'Blog',
to: '/blog',
},
{
label: 'GitHub',
href: 'https://github.com/facebook/docusaurus',
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
8 changes: 4 additions & 4 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'],
},
],
*/
Expand Down
1 change: 1 addition & 0 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
44 changes: 0 additions & 44 deletions src/pages/index.tsx

This file was deleted.

15 changes: 15 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down