tree: a36dbf3a048b58dab6179182376574b4031c6284 [path history] [tgz]
  1. blog/
  2. community/
  3. docs/
  4. learn/
  5. src/
  6. static/
  7. .asf.yaml
  8. .htaccess
  9. babel.config.js
  10. build_versioned_docs.sh
  11. docusaurus.config.ts
  12. fluss-versions.json
  13. package.json
  14. README.md
  15. sidebars.ts
  16. sidebarsCommunity.js
  17. tsconfig.json
website/README.md

Fluss Website

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

Requirements

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

$ npm install

Local Development

$ npm run 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.

Build

$ npm run 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 yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn 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.