Bitquery Data Platform Documentation

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

Installation

$ yarn

Local Development

$ yarn 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

$ export NODE_OPTIONS=--max_old_space_size=16000
$ yarn 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.

Generate PDF

yarn build

yarn serve

npx docusaurus-prince-pdf -u http://localhost:3000/docs/intro

Contributing to Docs

Read contribution guidlines here

Link checking

$ yarn build          # emit build/ so the checker can validate against real routes
$ yarn check-links    # fails on broken internal links / dead URL schemes

scripts/check-links.mjs validates links against the routes Docusaurus actually emits (it reads build/ when present), so it correctly resolves slug: front matter and extensionless relative links. It also runs in CI after the build.

Repo notes

• b5e8420ece5b4116b64bb3214828f286.txt and baidu_verify_codeva-*.html are third-party search-engine site-verification files. Do not delete them.
• The site is served in production by nginx (nginx/default.conf, Dockerfile), not Netlify. Redirects and 404 handling live in that nginx config.
• Every doc page carries the same CTAs (API key, Telegram/email, pricing, MCP, newsletter): a sticky card above the table of contents on desktop and a block after the article on mobile. Links and labels live in src/components/DocCTA/links.js; every link has a data-cta attribute for GTM click tracking.
• src/theme/DocItem/Layout/ is an eject of the Docusaurus 3.10.1 DocItem/Layout (not a wrapper) so the right column renders on pages without headings. When upgrading Docusaurus, diff it against node_modules/@docusaurus/theme-classic/lib/theme/DocItem/Layout/index.js and re-apply the three annotated changes. Pages with hide_table_of_contents: true get no desktop card by design.