Google Git
Sign in
apache / apache-website-template / refs/heads/docusaurus
commitf8129ca66fdff1c97e0749eb2ed319f1739f6f34[log] [tgz]
authortison <wander4096@gmail.com>Sun Feb 11 13:14:16 2024 +0800
committertison <wander4096@gmail.com>Sun Feb 11 13:14:16 2024 +0800
treed5edb540021cba5f243882b73deb9a1d84020b21
parentecb487e85c4dd15457847f611fab6bd49ac9a904 [diff]
docs: update README file

Signed-off-by: tison <wander4096@gmail.com>
1 file changed
tree: d5edb540021cba5f243882b73deb9a1d84020b21
  1. .github/
  2. blog/
  3. docs/
  4. src/
  5. static/
  6. .asf.yaml
  7. .gitignore
  8. babel.config.js
  9. docusaurus.config.ts
  10. LICENSE
  11. licenserc.toml
  12. NOTICE
  13. package.json
  14. pnpm-lock.yaml
  15. README.md
  16. tsconfig.json
README.md

Apache Website Template

This project contains a template website that aims to follow all the various required Apache Website Policies.

This template was generated using Docusaurus.

Usage

You can directly copy from the root path of this template repository to your website repository.

[!NOTE] TODO: Integrate it with template support of Docusaurus.

Most of the configurations are inherited from Docusaurus https://docusaurus.io/docs/configuration.

Specificly, our template defines a few metadata fields to customize for every project:

const projectName = "Template";
const mainRepoName = "apache-website-template";
const siteRepoName = "apache-website-template";

For example, Apache Fury can customize these fields as:

const projectName = "Fury";
const mainRepoName = "incubator-fury";
const siteRepoName = "incubator-fury-site";

More placeholders and preset are under developed.

Deploy

This template contains a GitHub Actions workflow to deploy the generated website content to the asf-site branch. It would work automatically, without any other ections required.