quivr/docs
Stan Girard b94642670c
docs: ✏️ search (#1535)
added search with lunr

# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.

## Checklist before requesting a review

Please delete options that are not relevant.

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged

## Screenshots (if appropriate):
2023-10-31 18:55:53 +01:00
..
docs docs: update Quivr doc (#1531) 2023-10-31 18:16:51 +01:00
src feat(docs): reworked the website (#1523) 2023-10-30 17:08:15 +01:00
static Feat/docs rework (#1525) 2023-10-30 20:53:39 +01:00
.gitignore feat(docs): added 2023-06-11 15:37:28 +02:00
babel.config.js feat(docs): added 2023-06-11 15:37:28 +02:00
docusaurus.config.js docs: ✏️ search (#1535) 2023-10-31 18:55:53 +01:00
package-lock.json feat(docs): added 2023-06-11 15:37:28 +02:00
package.json docs: ✏️ search (#1535) 2023-10-31 18:55:53 +01:00
README.md feat(docs): added 2023-06-11 15:37:28 +02:00
sidebars.js feat(docs): added 2023-06-11 15:37:28 +02:00
yarn.lock docs: ✏️ search (#1535) 2023-10-31 18:55:53 +01:00

Website

This website is built using Docusaurus 2, 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

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