https://github.com/superduper-io/superduper-docs
Main documentation for superduperdb
https://github.com/superduper-io/superduper-docs
Last synced: about 2 months ago
JSON representation
Main documentation for superduperdb
- Host: GitHub
- URL: https://github.com/superduper-io/superduper-docs
- Owner: superduper-io
- Created: 2023-10-12T11:01:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-17T12:13:26.000Z (about 2 months ago)
- Last Synced: 2025-04-18T01:48:08.981Z (about 2 months ago)
- Language: Jupyter Notebook
- Size: 21.2 MB
- Stars: 0
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# superduper Documentation Website
This documentation website is built using [Docusaurus 3.0](https://docusaurus.io/), a modern static website generator.
## Installation
As Docusaurus 3.0 lacks support for search functionality, we utilize Docusaurus 2.4 plugins. When installing, include the `--legacy-peer-deps` keyword to handle legacy peer dependencies.
```bash
npm install --legacy-peer-deps
```
## Local Development
To initiate a local development server and open a browser window, execute the following command. Most changes are reflected live without requiring a server restart.
```bash
npm run start
```
## Local Development with Search Feature
Since we employ local searching features, you need to build first and then serve it to see the result, as it builds its index during runtime.
```bash
npm run search
```
It will do both and show you a result. You have to run it again, if you want to see more changes.
## Build
To include the notebooks a template from the open-source project, check out the `superduper` project into the same parent directory.
Then run:
```bash
jupyter nbconvert ../superduper/templates/$name/build.ipynb --clear-output
jupyter nbconvert ../superduper/templates/$name/build.ipynb --to markdown
mv ../superduper/templates/$name/build.md docs/templates/$name.md
```
Generate static content into the `build` directory using the following command. The output can be served using any static content hosting service.
```bash
npm run build
```
## Deployment
### Using SSH:
```bash
USE_SSH=true npm run deploy
```
### Without SSH:
```bash
GIT_USER= npm run deploy
```
If you use GitHub Pages for hosting, this command conveniently builds the website and pushes it to the `gh-pages` branch.