LioranDB Documentation Site

This repository contains the source for the LioranDB documentation website:

• Live site: https://db.lioransolutions.com
• Main project repository: https://github.com/LioranGroupOfficial/LioranDB

The site is built with Docusaurus and is intended to document the LioranDB ecosystem:

• @liorandb/core (embedded, file-based database)
• @liorandb/db (server + CLI)
• @liorandb/driver (HTTP client/driver)

Requirements

• Node.js >= 20
• npm (recommended) or yarn

Getting started

Install dependencies:

npm install

Or with yarn:

yarn

Start the dev server:

npm run start

Or:

yarn start

Open http://localhost:3000 in your browser.

Editing docs

• Most docs live under docs/ (MDX).
• The sidebar is autogenerated from the docs/ folder structure (see sidebars.ts).
• To add a section, create a folder with an optional _category_.json.

Build

Generate a production build:

npm run build

Serve the production build locally:

npm run serve

Typecheck

npm run typecheck

Repo structure (high level)

• docs/ — Documentation content (MDX)
• src/pages/ — Custom pages (homepage, etc.)
• src/components/ — React components used by pages
• static/ — Static assets (images, icons)
• docusaurus.config.ts — Site configuration

Contributing

Issues and PRs are welcome:

1. Create a branch
2. Make changes in docs/ or src/
3. Run npm run build and npm run typecheck
4. Open a PR

Links

• Docs: https://db.lioransolutions.com
• GitHub: https://github.com/LioranGroupOfficial/LioranDB

License

See the main project repository for licensing details.