mirror of
https://github.com/LukeHagar/plex-docs.git
synced 2025-12-06 04:20:40 +00:00
Adjusted Sidebar, Styles, warning at the top.
This commit is contained in:
@@ -6,7 +6,7 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula");
|
|||||||
|
|
||||||
/** @type {import('@docusaurus/types').Config} */
|
/** @type {import('@docusaurus/types').Config} */
|
||||||
const config = {
|
const config = {
|
||||||
title: "Open Source API Documentation and SDKs for Plex",
|
title: "API Documentation and SDKs for Plex",
|
||||||
tagline:
|
tagline:
|
||||||
"Open and community sourced API documentation and SDKs for Plex with a kick!",
|
"Open and community sourced API documentation and SDKs for Plex with a kick!",
|
||||||
favicon: "img/favicon.ico",
|
favicon: "img/favicon.ico",
|
||||||
@@ -80,13 +80,14 @@ const config = {
|
|||||||
// Replace with your project's social card
|
// Replace with your project's social card
|
||||||
image: "img/Open-Graph-Image.png",
|
image: "img/Open-Graph-Image.png",
|
||||||
navbar: {
|
navbar: {
|
||||||
title: "Open Source API Documentation and SDKs for Plex",
|
title: "API Documentation and SDKs for Plex",
|
||||||
logo: {
|
logo: {
|
||||||
alt: "My Site Logo",
|
alt: "My Site Logo",
|
||||||
src: "img/logo.svg",
|
src: "img/favicon.ico",
|
||||||
},
|
},
|
||||||
items: [
|
items: [
|
||||||
{ to: "/docs/plex", label: "API", className: "indent" },
|
{ to: "/docs/plex", label: "API", className: "indent" },
|
||||||
|
{ to: "/docs/legacy", label: "Legacy", className: "indent" },
|
||||||
{ to: "/sdk-docs", label: "SDKs", className: "indent" },
|
{ to: "/sdk-docs", label: "SDKs", className: "indent" },
|
||||||
{ to: "/blog", label: "Blog", className: "indent" },
|
{ to: "/blog", label: "Blog", className: "indent" },
|
||||||
],
|
],
|
||||||
@@ -98,8 +99,12 @@ const config = {
|
|||||||
title: "Docs",
|
title: "Docs",
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: "OpenAPI Docs",
|
label: "API Documentation",
|
||||||
to: "/",
|
to: "/docs/plex",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: "SDK Documentation",
|
||||||
|
to: "/sdk-docs",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
@@ -110,10 +115,6 @@ const config = {
|
|||||||
label: "Blog",
|
label: "Blog",
|
||||||
to: "/blog",
|
to: "/blog",
|
||||||
},
|
},
|
||||||
{
|
|
||||||
label: "GitHub",
|
|
||||||
href: "https://github.com/facebook/docusaurus",
|
|
||||||
},
|
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
@@ -176,8 +177,10 @@ const config = {
|
|||||||
],
|
],
|
||||||
announcementBar: {
|
announcementBar: {
|
||||||
id: "announcementBar_1",
|
id: "announcementBar_1",
|
||||||
|
backgroundColor: "red",
|
||||||
|
textColor: "white",
|
||||||
content:
|
content:
|
||||||
"This is not an Official Plex.TV Resource and is built or maintained by Plex. If you have any feedback on the <a href='https://github.com/LukeHagar/plex-docs'>Website</a> or the <a href='https://github.com/LukeHagar/plex-api-spec'>API Specification</a> please let me know!",
|
"This is not an Official Plex.TV Resource and is not built or maintained by Plex. If you have any feedback on the <a href='https://github.com/LukeHagar/plex-docs'>Website</a> or the <a href='https://github.com/LukeHagar/plex-api-spec'>API Specification</a> please let me know!",
|
||||||
},
|
},
|
||||||
metadata: [
|
metadata: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ const sidebars = {
|
|||||||
{
|
{
|
||||||
type: "category",
|
type: "category",
|
||||||
label: "Plex Media Server API",
|
label: "Plex Media Server API",
|
||||||
collapsible: false,
|
collapsible: true,
|
||||||
collapsed: false,
|
collapsed: true,
|
||||||
link: {
|
link: {
|
||||||
type: "generated-index",
|
type: "generated-index",
|
||||||
title: "Plex Media Server API",
|
title: "Plex Media Server API",
|
||||||
@@ -18,8 +18,8 @@ const sidebars = {
|
|||||||
{
|
{
|
||||||
type: "category",
|
type: "category",
|
||||||
label: "Plex TV API",
|
label: "Plex TV API",
|
||||||
collapsible: false,
|
collapsible: true,
|
||||||
collapsed: false,
|
collapsed: true,
|
||||||
link: {
|
link: {
|
||||||
type: "generated-index",
|
type: "generated-index",
|
||||||
title: "Plex TV API",
|
title: "Plex TV API",
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ const FeatureList = [
|
|||||||
Svg: require("@site/static/img/undraw_docusaurus_mountain.svg").default,
|
Svg: require("@site/static/img/undraw_docusaurus_mountain.svg").default,
|
||||||
description: (
|
description: (
|
||||||
<>
|
<>
|
||||||
API Documentation dynamically generated from an{" "}
|
API Documentation and SDK for Plex dynamically generated from an{" "}
|
||||||
<a
|
<a
|
||||||
href="https://github.com/LukeHagar/plex-api-spec"
|
href="https://github.com/LukeHagar/plex-api-spec"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
@@ -25,7 +25,8 @@ const FeatureList = [
|
|||||||
Svg: require("@site/static/img/undraw_docusaurus_tree.svg").default,
|
Svg: require("@site/static/img/undraw_docusaurus_tree.svg").default,
|
||||||
description: (
|
description: (
|
||||||
<>
|
<>
|
||||||
The OpenAPI Specification is fully open source, and everyone is welcome{" "}
|
The OpenAPI Specification is fully open source, and everyone is welcome
|
||||||
|
to{" "}
|
||||||
<a
|
<a
|
||||||
href="https://github.com/LukeHagar/plex-api-spec/issues"
|
href="https://github.com/LukeHagar/plex-api-spec/issues"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
@@ -46,18 +47,15 @@ const FeatureList = [
|
|||||||
),
|
),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Potential for SDKs",
|
title: "SDKs",
|
||||||
Svg: require("@site/static/img/undraw_docusaurus_react.svg").default,
|
Svg: require("@site/static/img/undraw_docusaurus_react.svg").default,
|
||||||
description: (
|
description: (
|
||||||
<>
|
<>
|
||||||
The Open API Specification can be used to generate SDKs in a number of
|
The Open API Specification is used to automatically generate SDKs in a
|
||||||
different languages (JS/TS, GO, Python, Powershell) using existing{" "}
|
number of different languages (JavaScript/TypeScript, GO, Python,
|
||||||
<a
|
etc...) using{" "}
|
||||||
href="https://openapi-generator.tech"
|
<a href="https://www.speakeasyapi.dev" target="_blank" rel="noreferrer">
|
||||||
target="_blank"
|
the world class OpenAPI Generation platform Speakeasy
|
||||||
rel="noreferrer"
|
|
||||||
>
|
|
||||||
time tested tools
|
|
||||||
</a>
|
</a>
|
||||||
.
|
.
|
||||||
</>
|
</>
|
||||||
|
|||||||
@@ -6,25 +6,25 @@
|
|||||||
|
|
||||||
/* You can override the default Infima variables here. */
|
/* You can override the default Infima variables here. */
|
||||||
:root {
|
:root {
|
||||||
--ifm-color-primary: #f7c600;
|
--ifm-color-primary: #0047ab;
|
||||||
--ifm-color-primary-dark: #191919;
|
--ifm-color-primary-dark: #00409a;
|
||||||
--ifm-color-primary-darker: #277148;
|
--ifm-color-primary-darker: #003c91;
|
||||||
--ifm-color-primary-darkest: #205d3b;
|
--ifm-color-primary-darkest: #003278;
|
||||||
--ifm-color-primary-light: #33925d;
|
--ifm-color-primary-light: #004ebc;
|
||||||
--ifm-color-primary-lighter: #359962;
|
--ifm-color-primary-lighter: #0052c5;
|
||||||
--ifm-color-primary-lightest: #3cad6e;
|
--ifm-color-primary-lightest: #005cde;
|
||||||
--ifm-code-font-size: 95%;
|
--ifm-code-font-size: 95%;
|
||||||
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
|
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
||||||
[data-theme="dark"] {
|
[data-theme="dark"] {
|
||||||
--ifm-color-primary: #f7c600;
|
--ifm-color-primary: #20b4fe;
|
||||||
--ifm-color-primary-dark: #deb200;
|
--ifm-color-primary-dark: #04aafe;
|
||||||
--ifm-color-primary-darker: #d2a800;
|
--ifm-color-primary-darker: #01a2f2;
|
||||||
--ifm-color-primary-darkest: #ad8b00;
|
--ifm-color-primary-darkest: #0185c7;
|
||||||
--ifm-color-primary-light: #ffd011;
|
--ifm-color-primary-light: #3cbefe;
|
||||||
--ifm-color-primary-lighter: #ffd21d;
|
--ifm-color-primary-lighter: #4bc2fe;
|
||||||
--ifm-color-primary-lightest: #ffda42;
|
--ifm-color-primary-lightest: #75d1fe;
|
||||||
--ifm-background-color: #151515;
|
--ifm-background-color: #000000;
|
||||||
}
|
}
|
||||||
@@ -29,7 +29,7 @@ export default function Home() {
|
|||||||
return (
|
return (
|
||||||
<Layout
|
<Layout
|
||||||
title={`Home`}
|
title={`Home`}
|
||||||
description="Community Made Plex Media Server API Documentation"
|
description="Community Made API Documentation for Plex"
|
||||||
>
|
>
|
||||||
<HomepageHeader />
|
<HomepageHeader />
|
||||||
<main>
|
<main>
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ export default function SdkDocs() {
|
|||||||
return (
|
return (
|
||||||
<Layout
|
<Layout
|
||||||
title={`SDK Docs`}
|
title={`SDK Docs`}
|
||||||
description="Community Made Plex Media Server SDK Documentation"
|
description="Community Made SDK Documentation for Plex"
|
||||||
noFooter
|
noFooter
|
||||||
>
|
>
|
||||||
<iframe
|
<iframe
|
||||||
|
|||||||
Reference in New Issue
Block a user