Docusaurus Documentation

website·Indexed 30 days ago

https://chisquares.github.io/chisquares-docs

Documentation for Docusaurus, a static-site-generator (Jamstack) used to build documentation sites. It features support for Markdown, React pages, versioning, i18n translation, and blog post management.

Tokens: 12.7K
Snippets: 128
Records: 147
Agent score: 64%

What's inside Docusaurus

Overview of Docusaurus core features
Docusaurus is a documentation framework designed for quick installation and deployment. It allows developers to focus on content by placing documentation files in the docs directory and provides extensibility through React, enabling custom website layouts while maintaining consistent header and footer components.
https://chisquares.github.io/chisquares-docs/yo-NG/
Overview of Docusaurus core features
Docusaurus is a documentation framework designed for quick installation and deployment. It allows developers to focus on content by placing documentation files in the docs directory and provides the ability to extend or customize website layouts using React while maintaining consistent global elements like headers and footers.
https://chisquares.github.io/chisquares-docs/zu-ZA/
Create and manage blog posts in Docusaurus
Docusaurus blogging features are powered by the @docusaurus/plugin-content-blog plugin. To create blog posts, add Markdown files or folders to the blog directory.
Key management tips:
- Dates: The blog post date is automatically extracted from filenames (e.g., 2019-05-30-welcome.md or 2019-05-30-welcome/index.md).
- Assets: Using a folder for a blog post (with an index.md inside) allows you to co-locate images with the post content.
- Authors: Regular blog authors can be defined in the authors.yml file.
- Tags: The blog system supports the use of tags for categorization.
https://chisquares.github.io/chisquares-docs/yo-NG/blog/welcome/
Build a Docusaurus site for production
Docusaurus is a static-site-generator that compiles your site into static HTML, JavaScript, and CSS files. To generate these production files, run the build command. The resulting static assets are output to the build folder.
```
npm run build
```
https://chisquares.github.io/chisquares-docs/zh-Hans/docs/tutorial-basics/deploy-your-site/
Create interactive blog posts using MDX in Docusaurus
Docusaurus blog posts support MDX, allowing the use of React components and JSX directly within markdown files to create interactive content.
```
<button onClick={() => alert('button clicked!')}>
  Click me!
</button>
```
https://chisquares.github.io/chisquares-docs/blog/mdx-blog-post/
Create a basic document in Docusaurus
To create a new document, create a Markdown file within the docs directory. For example, creating docs/hello.md will make the document available at the /docs/hello URL path.
```
# Hello

This is my **first Docusaurus document**!
```
https://chisquares.github.io/chisquares-docs/zu-ZA/docs/tutorial-basics/create-a-document/
Create standalone pages in src/pages
To create a standalone page, add a Markdown or React file to the src/pages directory. The file system determines the URL path:
- src/pages/index.js maps to the root /
- src/pages/foo.md maps to /foo
- src/pages/foo/bar.js maps to /foo/bar
https://chisquares.github.io/chisquares-docs/zh-Hans/docs/tutorial-basics/create-a-page/
Manage blog posts in Docusaurus
Docusaurus blogging features are powered by the @docusaurus/plugin-content-blog plugin. To create blog posts, add Markdown files or folders to the blog directory. You can define regular blog authors in the authors.yml file. Blog posts support tags for categorization.
https://chisquares.github.io/chisquares-docs/zu-ZA/blog/welcome/
Set blog post dates using filenames in Docusaurus
Docusaurus can automatically extract the blog post date from the filename. Use the format YYYY-MM-DD-title.md or place an index.md inside a folder named YYYY-MM-DD-title.
```
2019-05-30-welcome.md
2019-05-30-welcome/index.md
```
https://chisquares.github.io/chisquares-docs/zu-ZA/blog/welcome/

Create a blog post in Docusaurus

To create a blog post in Docusaurus, create a Markdown file within the blog/ directory. The filename should follow a date-based naming convention (e.g., YYYY-MM-DD-title.md). Docusaurus automatically generates a dedicated page for the post, updates the blog index page, manages the tag system, and updates the RSS feed.

---
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 as you like.

Create callouts using Admonitions
Docusaurus provides a special syntax for creating admonitions (callouts) such as tips and danger warnings using the :::type[Title] format.
```
:::tip[My tip]
Use this awesome feature option
:::

:::danger[Take care]
This action is dangerous
:::
```
https://chisquares.github.io/chisquares-docs/zu-ZA/docs/tutorial-basics/markdown-features/
Set blog post dates via filenames
Docusaurus can automatically extract the blog post date from the filename. Use the format YYYY-MM-DD-title.md or place an index.md inside a folder named YYYY-MM-DD-title.
```
2019-05-30-welcome.md
2019-05-30-welcome/index.md
```
https://chisquares.github.io/chisquares-docs/blog/welcome/