Skip to content

Latest commit

 

History

History

README.md

Apache Fesod (Incubating) Website

This website is built using Docusaurus, a modern static website generator.

Requirements

  • Node.js version 24.0 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed.
  • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Installation

pnpm install

Local Development

Preview the English website locally:

pnpm start

Preview the Chinese website locally:

pnpm start --locale zh-cn

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Internationalization

To write Chinese translation files, run:

pnpm write-translations --locale zh-cn

To write English translation files, run:

pnpm write-translations --locale en

Build

pnpm build

This command generates static content into the build directory and can be served using any static contents hosting service.

Directory Structure

|-- community             # community directory
|-- docs                  # document directory
|-- i18n
|   `-- zh-cn             # internationalized chinese
|       |-- code.json
|       |-- docusaurus-plugin-content-docs
|       |-- docusaurus-plugin-content-community
|       `-- docusaurus-theme-classic
|-- src
|-- static
|   |-- img               # picture static resource
|   |   |-- blog          # blog picture
|   |   |-- docs          # document picture
|   |   |-- index         # homepage picture
|-- docusaurus.config.js
|-- sidebars.js           # document sidebar menu configuration
|-- sidebarsCommunity.js  # community document sidebar menu configuration