Skip to content

tigerwangyb/byconity.github.io

 
 

Repository files navigation

byconity.github.io

Developing

This website is powered by Docusarus. We are using version 2.x at the moment. You are encouraged to understand the basics of Docusaurus first.

npm install # Install NPM dependencies

npm start # Start local server, OR

npm start -l zh-cn # Start the zh-cn server

npm run build # Build the Website

General Folder Structure

byconity.github.io/
├── docs/ # Latest English docs, use kebab-case
│   ├── category-1
│   │   ├── assets/ # Images used in category-1
│   │   ├── _category_.json # Metadata for category-1
│   │   └──doc-1.md
│   ├── doc-2.md
│   └── doc-3.md
│
├── versioned_docs/
│   └── version-0.2.0 # Version 0.2.0 English docs, use kebab-case
│       ├── category-1
│       │   ├── assets/ # Images used in category-1
│       │   ├── _category_.json # Metadata for category-1
│       │   └──doc-1.md
│       ├── doc-2.md
│       └── doc-3.md
│
├── versioned_sidebars/
│   └── version-0.2.0-sidebars.json # Version 0.2.0 English sidebar
│
├── blog/ # English blogs, use kebab-case
│   ├── 2021-01-01-happy-new-year.md
│   └── 2021-02-14-valentines-day.md
│
├── i18n/
│   └── zh-CN/
│       ├── docusaurus-plugin-content-docs/
│       │   │── current/ # Latest Chinese docs, use kebab-case
│       │   │   ├── category-1
│       │   │   │   ├── assets/ # Images used in category-1
│       │   │   │   ├── _category_.json # Metadata for category-1
│       │   │   │   └──doc-1.md
│       │   │   ├── doc-2.md
│       │   │   └── doc-3.md
│       │   │── current.json # Latest Chinese sidebar
│       │   │
│       │   │── version-0.2.0/ # Version 0.2.0 Chinese docs, use kebab-case
│       │   │   ├── category-1
│       │   │   │   ├── assets/ # Images used in category-1
│       │   │   │   ├── _category_.json # Metadata for category-1
│       │   │   │   └──doc-1.md
│       │   │   ├── doc-2.md
│       │   │   └── doc-3.md
│       │   └── version-0.2.0.json # Version 0.2.0 Chinese sidebar
│       │
│       └── docusaurus-plugin-content-blog/
│           └── current/ # Chinese blogs, use kebab-case
│               ├── 2021-01-01-happy-new-year.md
│               └── 2021-02-14-valentines-day.md
│
├── src/ # Website source code
└── static/
    └── img/
        └── dbyconity-social-card # Opengraph Social Card

For Writers

Docs

File Location

Version Language Path
Latest en docs/
Latest zh-cn i18n/zh-cn/docusaurus-plugin-content-docs/current/
0.2.0 en versioned_docs/version-0.2.0/
0.2.0 zh-cn i18n/zh-cn/docusaurus-plugin-content-docs/version-0.2.0/

Editing Docs

Blog Posts

File Location

Language Path
en blog/
zh-cn i18n/zh-cn/docusaurus-plugin-content-blog/current/

Editing Blog Posts

About

Official site for https://github.com/ByConity/ByConity

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • MDX 99.0%
  • Other 1.0%