Skip to content

apache/incubator-answer-website

Repository files navigation

Website

Apache Answer official website is built using Docusaurus, and we use pnpm to manage dependencies.

# Directory description
.
├── blog       # blog posts
├── community  # community docs
├── docs       # using docs
├── i18n       # translation files
├── plugins    # plugin config
├── src        # components, custom css and pages
├── static     # static files
└── ...

Installation

# pnpm version should > 8
pnpm i

Local Development

pnpm start

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

Warning

Please edit .drawio.svg files in the Draw.io editor to avoid losing file layer information.

Build

pnpm build

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

Deployment

Using SSH:

USE_SSH=true pnpm deploy

Not using SSH:

GIT_USER=<Your GitHub username> pnpm deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.