Skip to content

Adding custom metadata to documentation to improve Algolia search results for Chinese readers.

Notifications You must be signed in to change notification settings

DanRoscigno/DocusaurusAlgoliaCustomMetadata

This branch is 1 commit ahead of, 95 commits behind main.

Repository files navigation

Website

Node version

Docusaurus v3 requires Node 18

I use 8GB for Node, in Netlify I set the build command in the file netlify.toml and locally I use:

NODE_OPTIONS=--max_old_space_size=8192

Install Docusaurus

yarn install

Build script

The script _IGNORE/testbuild

  • pulls the Chinese and English docs for versions 3.1 and 3.0
  • Removes the intro page while we update it to use built-in nav components
  • Removes the TOC while we migrate those to JSON format
  • Runs an MDX checker
  • Builds the site
./_IGNORE/testbuild`

Note: The dir is named _IGNORE because I had some markdown files that I needed to move to a dir that Docusaurus would leave out of the nav; it does not add files to the nav from dirs that start with an underscore.

Serve the pages locally

yarn serve

About

Adding custom metadata to documentation to improve Algolia search results for Chinese readers.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published