iv-org/documentation
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/documentation synced 2025-06-05 22:19:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update channels api docs (#326)

Browse Source 
* Add a page specifying common object types

* Add a page for the /api/v1/channels endpoint

* Remove obselete definitions from api.md

* Add/update links in index.md and mkdocs.yml

* Impove MkDocs config to support code highlight & copy button

* Use native JS types for better syntax highlighting
This commit is contained in:
Samantaz Fox
2023-01-14 11:01:24 +00:00
committed by GitHub
parent 4a66173585
commit dca939835c
6 changed files with 250 additions and 199 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
mkdocs.yml
View File

@@ -31,7 +31,9 @@ nav:
- 'takedown.md'
- 'For Developers':
- 'api.md'
- 'authenticated-endpoints.md'
- 'api/common_types.md'
- 'api/channels_endpoint.md'
- 'api/authenticated-endpoints.md'
theme:
name: material
@@ -44,6 +46,7 @@ theme:
- navigation.tracking # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-tracking
- navigation.expand # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-expansion
- navigation.top # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button
- content.code.copy # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button
extra:
social:
@@ -52,3 +55,8 @@ extra:
markdown_extensions:
- pymdownx.magiclink
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences