This is the documentation website for SimpleBLE, a cross-platform Bluetooth Low Energy (BLE) library.
Built with Fumadocs and Next.js.
Run the development server:
npm run devOpen http://localhost:3000 with your browser to see the result.
The API reference is automatically generated from the C++ source code using Doxygen and a custom parser that converts Doxygen XML to MDX with React components.
npm run build:doxygen: Orchestrates the full API documentation build.- Runs Doxygen using the
Doxyfileto generate XML output in_doxygen/xml/. - Executes
scripts/build-doxygen.jsto parse the XML and generatecontent/docs/simpleble/api.mdx.
- Runs Doxygen using the
npm run build: Runs the Doxygen build followed by the Next.js production build.
scripts/build-doxygen.js: The main entry point for API generation. It defines which classes to include (Standard API, Safe API, etc.) and uses the helpers inutils.jsto generate the final MDX file.scripts/utils.js: Contains the logic for:- Parsing Doxygen XML nodes.
- Extracting text, types, and method signatures safely.
- Converting XML structures into
<ApiClass>,<ApiMethod>, and<ApiSection>React components. - Handling edge cases like C++ template types, escaping JSX/Markdown, and generating stable anchor IDs for the Table of Contents.
| Route | Description |
|---|---|
app/(home) |
The landing page. |
app/(docs) |
The documentation layout and pages. |
content/docs |
MDX/Markdown files for the documentation. |
src/components/api |
Custom React components used in the API reference. |
scripts/ |
Automation scripts for Doxygen integration. |