Mirrors/blakeblackshear.frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2024-11-21 19:07:46 +01:00
Code Issues Projects Releases Wiki Activity
757150dec1
blakeblackshear.frigate/docs
History
Rui Alves 757150dec1
Use Swagger documentation for Frigate HTTP API (#14178) 
* Updated documentation

* docusaurus.config and sidebars converted to Typescript to allow for typings

* Added type for sidebars.ts

* Replaced integrations/api.md with automatically generated openAPI specification. Make sidebar collapsible to increase readability

* Fix HTTP API links in the documentation

* Added rust as language in the openapi sidebar

* Make sure configuration/pwa is present

* Fix API slug

* Fix links

* Revert sidebarCollapsible configuration

* Make HTTP API sidebar collapsed by default. Added CSS for OpenAPI methods

* Proper localhost server path

* Proper localhost server path

* No introduction page

* Lint
2024-10-07 14:27:35 -06:00
..
docs Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
plugins docs: include available objects in documentation 2021-03-09 06:23:37 -06:00
src/css Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
static Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
.gitignore docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
babel.config.js docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
docusaurus.config.ts Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
package-lock.json Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
package.json Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
README.md Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
sidebars.ts Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00

README.md

Website

This website is built using Docusaurus 3.5, a modern static website generator.

For installation and contributing instructions, please follow the Contributing Docs.

Development

  1. Run npm i to install dependencies
  2. Run npm run start to start the website