administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2025-12-06 05:24:11 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
84c3f98a09
frigate/docs/README.md

11 lines
360 B
Markdown
Raw Normal View History

docs: move docs to docusaurus
2021-01-21 03:26:49 +03:00
# Website
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 23:27:35 +03:00
This website is built using [Docusaurus 3.5](https://docusaurus.io/docs), a modern static website generator.
docs: move docs to docusaurus
2021-01-21 03:26:49 +03:00
Update docs link (#6657)
2023-05-31 15:15:01 +03:00
For installation and contributing instructions, please follow the [Contributing Docs](https://docs.frigate.video/development/contributing).
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 23:27:35 +03:00
# Development
1. Run `npm i` to install dependencies
2. Run `npm run start` to start the website
Reference in New Issue Copy Permalink