History

* fix: not every llm stream chunked by each json data

* Docs: deploy docusaurus github page and update README.md (#14)

* add github action deploy docusaurus to github page

* README: update installation instruction

* Add sonarqube scanner github actions pipeline

---------

Co-authored-by: Hien To <>

---------

Co-authored-by: Louis <louis@jan.ai>

2023-08-30 11:19:25 +07:00

docs

docs: add redocusaurus

2023-08-25 14:32:55 +08:00

openapi

docs: add redocusaurus

2023-08-25 14:32:55 +08:00

src

docs: scaffolded nav

2023-08-24 16:27:07 +08:00

static

docs: scaffolded nav

2023-08-24 16:27:07 +08:00

.gitignore

docs: scaffold docusaurus classic

2023-08-24 13:53:13 +08:00

babel.config.js

docs: scaffold docusaurus classic

2023-08-24 13:53:13 +08:00

docusaurus.config.js

Update docs (#15 )

2023-08-30 11:19:25 +07:00

package-lock.json

docs: add redocusaurus

2023-08-25 14:32:55 +08:00

package.json

docs: add redocusaurus

2023-08-25 14:32:55 +08:00

README.md

docs: add redocusaurus

2023-08-25 14:32:55 +08:00

sidebars.js

docs: add redocusaurus

2023-08-25 14:32:55 +08:00

README.md

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.

Additional Plugins

@docusaurus/theme-live-codeblock
Redocusaurus: manually upload swagger files at /openapi/OpenAPISpec.json