tree: c14b5311e89e0b40380b2a89285c7789cd8262cc
  1. blog/
  2. community/
  3. docs/
  4. i18n/
  5. src/
  6. static/
  7. .markdownlint-cli2.jsonc
  8. docusaurus.config.js
  9. github-avatar.js
  10. package.json
  11. pnpm-lock.yaml
  12. pnpm-workspace.yaml
  13. README.md
  14. sidebars.js
  15. sidebarsCommunity.js
website/README.md

Apache Fesod (Incubating) Website

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

Requirements

  • Node.js version 20.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.

Team Page

Member

Update the member information in src/pages/team/data/member.json File.

Avatar

pnpm github-avatar

This command will fetch the base64 string of the GitHub avatar from file src/pages/team/data/member.json, and store the result in the src/pages/team/data/ directory. The operation might take a little while.

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