Internal package for doc generation

This package generates .md files inside the docs folder using typedoc and typedoc-plugin-markdown.

The .md files are generated when releasing packages. They are then published to huggingface.co through the doc-builder's github action.

We run a few scripts in between, fix-md-links and update-toc to preprocess the files for doc-builder.

Commands

# Generate all docs
pnpm run start

HTML docs

If you want to see the final HTML docs, there are a few steps:

• Generate the docs with pnpm run start
• Clone https://github.com/huggingface/doc-builder and put it in the same folder as huggingface.js
• Follow the instructions to install it from source
• Go in its kit folder and run npm install

Then:

# Inside the doc-builder folder
doc-builder preview huggingface.js ../huggingface.js/docs --not_python_module