Repo for langfuse.com, based on Nextra
You can easily contribute to the docs using GitHub Codespaces. Just click on the "Code" button and select "Open with Codespaces". This will open a new Codespace with all the dependencies installed and the development server running.
Pre-requisites: Node.js 18+, pnpm
- Optional: Create env based on .env.template
- Run
pnpm ito install the dependencies. - Run
pnpm devto start the development server on localhost:3333
All Jupyter notebooks are in the cookbook/ directory. For JS/TS notebooks we use Deno, see Readme in cookbook folder for more details.
To render them within the documentation site, we convert them to markdown using jupyter nbconvert, move them to right path in the pages/ directory where they are rendered by Nextra (remark).
Steps after updating notebooks:
- Load python shell/env which has jupyter installed, e.g.
poetry install && poetry shell - Run
bash scripts/update_cookbook_docs.sh - Commit the changed markdown files
Note: All .md files in the pages/ directory are automatically generated from Jupyter notebooks. Do not edit them manually as they will be overwritten. Always edit the Jupyter notebooks and run the conversion script.
We store all images in the public/images/ directory. To use them in the markdown files, use the abslute path /images/your-image.png.
We use Cloudflare Video as a video hosting provider. Ping one of the maintainers to upload a video to Cloudflare Video and get the video id.
To embed a video, use the CloudflareVideo component and set a title and fixed aspect ratio.
To embed a "gif", actually embed a video via the CloudflareVideo component and use gifMode (<CloudflareVideo videoId="" gifMode />). This will look like a gif, but at a much smaller file size and higher quality.
Interested in stack of Q&A docs chatbot? Checkout the blog post for implementation details (all open source)
Run pnpm run analyze to analyze the bundle size of the production build using @next/bundle-analyzer.