Fluent Documentation Site

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

Want to contribute? Check out our Contributing Guidelines to get started! 🚀

Cloudflare Pages Hosted Website

https://docs.fluent.xyz/

Installation

Node Version v23.3.0

nvm use v23.3.0

Install npm packages:

npm i

or

npm install --legacy-peer-deps

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.

GitHub Pages Deployment Guide

1. Go to the following project path as an admin to a GitHub repo:

https://github.com/"repo-owner"/"repo-name"/settings/pages

2. On that page, find

    Build and deployment
        Source

then click the drop down options to click

GitHub Actions

3. Copy YAML files:

deploy.yml
test-deploy.yml

into:

.github/workflows/mdbook.yml

from this guide under:

Same > Github action files

and modify files from yarn to npm as shown in the guide

If you use npm, change:
    -cache: yarn, 
    -yarn install --frozen-lockfile, 
    -yarn build 
to 
    -cache: npm, 
    -npm ci, 
    -npm run build 
accordingly.

here:

https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions

Cloudflare Pages Hosting and CI/CD Pull Request Build and Preview Pipeline

Cloudflare Pages Setup Steps:

1. On the Cloudflare Dashboard, navigate the left column sidebar for:

Workers and Pages > Create > Pages

2. Then on pages, navigate to:

Connect to Git > Import GitHub Repos > Select Repo > Begin Setup > Framework preset > Docusaurus > Save and Deploy

Tutorials used for reference:

https://www.youtube.com/watch?v=O4jV8Zz2w9I

https://www.youtube.com/watch?v=t068JaUiuj4&t=85s

Search Bar

Add Algolia Search Bar with API Key:

https://docusaurus.io/docs/search#connecting-algolia

Search bar support without Algolia API Key (loads after deployed to production):

https://github.com/praveenn77/docusaurus-lunr-search