outline

2022-08-25 17:18:23 -04:00 · 2022-08-25 17:18:23 -04:00 · bee9c5a0e6
commit bee9c5a0e6
parent 3ff468781d
8 changed files with 6 additions and 288 deletions
--- a/docs/basics/congratulations.md
+++ b/docs/basics/congratulations.md
@ -1,21 +0,0 @@
 ---
 sidebar_position: 6
 ---
 # Congratulations!
 You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
 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)**.
 Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
 ## What's next?
 - Read the [official documentation](https://docusaurus.io/).
 - Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
 - Add a [search bar](https://docusaurus.io/docs/search)
 - Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
 - Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
--- a/docs/basics/create-a-blog-post.md
+++ b/docs/basics/create-a-blog-post.md
@ -1,34 +0,0 @@
 ---
 sidebar_position: 3
 ---
 # Create a Blog Post
 Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
 ## Create your first Post
 Create a file at `blog/2021-02-28-greetings.md`:
 ```md title="blog/2021-02-28-greetings.md"
 ---
 slug: greetings
 title: Greetings!
 authors:
  - name: Joel Marcey
    title: Co-creator of Docusaurus 1
    url: https://github.com/JoelMarcey
    image_url: https://github.com/JoelMarcey.png
  - name: Sébastien Lorber
    title: Docusaurus maintainer
    url: https://sebastienlorber.com
    image_url: https://github.com/slorber.png
 tags: [greetings]
 ---
 Congratulations, you have made your first post!
 Feel free to play around and edit this post as much you like.
 ```
 A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
--- a/docs/basics/create-a-document.md
+++ b/docs/basics/create-a-document.md
@ -1,55 +0,0 @@
 ---
 sidebar_position: 2
 ---
 # Create a Document
 Documents are **groups of pages** connected through:
 - a **sidebar**
 - **previous/next navigation**
 - **versioning**
 ## Create your first Doc
 Create a Markdown file at `docs/hello.md`:
 ```md title="docs/hello.md"
 # Hello
 This is my **first Docusaurus document**!
 ```
 A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
 ## Configure the Sidebar
 Docusaurus automatically **creates a sidebar** from the `docs` folder.
 Add metadata to customize the sidebar label and position:
 ```md title="docs/hello.md" {1-4}
 ---
 sidebar_label: 'Hi!'
 sidebar_position: 3
 ---
 # Hello
 This is my **first Docusaurus document**!
 ```
 It is also possible to create your sidebar explicitly in `sidebars.js`:
 ```js title="sidebars.js"
 module.exports = {
  tutorialSidebar: [
    {
      type: 'category',
      label: 'Tutorial',
      // highlight-next-line
      items: ['hello'],
    },
  ],
 };
 ```
--- a/docs/basics/deploy-your-site.md
+++ b/docs/basics/deploy-your-site.md
@ -1,31 +0,0 @@
 ---
 sidebar_position: 5
 ---
 # Deploy your site
 Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
 It builds your site as simple **static HTML, JavaScript and CSS files**.
 ## Build your site
 Build your site **for production**:
 ```bash
 npm run build
 ```
 The static files are generated in the `build` folder.
 ## Deploy your site
 Test your production build locally:
 ```bash
 npm run serve
 ```
 The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
 You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
--- a/docs/basics/markdown-features.mdx
+++ b/docs/basics/markdown-features.mdx
@ -1,146 +0,0 @@
 ---
 sidebar_position: 4
 ---
 # Markdown Features
 Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
 ## Front Matter
 Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
 ```text title="my-doc.md"
 // highlight-start
 ---
 id: my-doc-id
 title: My document title
 description: My document description
 slug: /my-custom-url
 ---
 // highlight-end
 ## Markdown heading
 Markdown text with [links](./hello.md)
 ```
 ## Links
 Regular Markdown links are supported, using url paths or relative file paths.
 ```md
 Let's see how to [Create a page](/create-a-page).
 ```
 ```md
 Let's see how to [Create a page](./create-a-page.md).
 ```
 **Result:** Let's see how to [Create a page](./create-a-page.md).
 ## Images
 Regular Markdown images are supported.
 You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
 ```md
 ![Docusaurus logo](/img/docusaurus.png)
 ```
 ![Docusaurus logo](/img/docusaurus.png)
 You can reference images relative to the current file as well, as shown in [the extra guides](../tutorial-extras/manage-docs-versions.md).
 ## Code Blocks
 Markdown code blocks are supported with Syntax highlighting.
    ```jsx title="src/components/HelloDocusaurus.js"
    function HelloDocusaurus() {
        return (
            <h1>Hello, Docusaurus!</h1>
        )
    }
    ```
 ```jsx title="src/components/HelloDocusaurus.js"
 function HelloDocusaurus() {
  return <h1>Hello, Docusaurus!</h1>;
 }
 ```
 ## Admonitions
 Docusaurus has a special syntax to create admonitions and callouts:
    :::tip My tip
    Use this awesome feature option
    :::
    :::danger Take care
    This action is dangerous
    :::
 :::tip My tip
 Use this awesome feature option
 :::
 :::danger Take care
 This action is dangerous
 :::
 ## MDX and React Components
 [MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
 ```jsx
 export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '20px',
      color: '#fff',
      padding: '10px',
      cursor: 'pointer',
    }}
    onClick={() => {
      alert(`You clicked the color ${color} with label ${children}`)
    }}>
    {children}
  </span>
 );
 This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
 This is <Highlight color="#1877F2">Facebook blue</Highlight> !
 ```
 export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '20px',
      color: '#fff',
      padding: '10px',
      cursor: 'pointer',
    }}
    onClick={() => {
      alert(`You clicked the color ${color} with label ${children}`);
    }}>
    {children}
  </span>
 );
 This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
 This is <Highlight color="#1877F2">Facebook blue</Highlight> !
--- a/docs/links.md
+++ b/docs/links.md
@ -0,0 +1,5 @@
 ---
 sidebar_position: 3
 ---
 # Official Links
--- a/docs/overview/_category_.json
+++ b/docs/overview/_category_.json
@ -1,5 +1,5 @@
 {
-  "label": "The Basics",
+  "label": "Overview",
  "position": 2,
  "link": {
    "type": "generated-index",
--- a/docs/overview/create-a-page.md
+++ b/docs/overview/create-a-page.md