Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BlackDark committed Jan 13, 2025
1 parent bbbb6df commit 6928f2b
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 16 deletions.
37 changes: 27 additions & 10 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ import { default as lunrSearch } from "docusaurus-lunr-search";
import { themes as prismThemes } from "prism-react-renderer";

// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)

const config: Config = {
title: "Configarr",
tagline: "Automate your media server configuration",
tagline: "Simplified configuration management for your Arr applications like Sonarr, Radarr and more.",
favicon: "img/favicon.ico",

// Set the production url of your site here
Expand Down Expand Up @@ -85,6 +84,19 @@ const config: Config = {
colorMode: {
defaultMode: "dark",
},
metadata: [
{
name: "description",
content: "Configarr - Simplify your configuration management for Arr applications like Sonarr, Radarr, Readarr, Lidarr.",
},
{ name: "keywords", content: "configarr, configuration, management, automation, sonarr, radarr, lidarr, recyclarr, notifiarr" },
{ name: "robots", content: "index, follow" },
{ property: "og:title", content: "Configarr - Configuration Management Simplified" },
{
property: "og:description",
content: "Easily manage and automate your configurations in Arr (Sonarr,Radarr,Lidarr,Readarr) with Configarr.",
},
],
navbar: {
title: "Configarr",
logo: {
Expand Down Expand Up @@ -121,18 +133,14 @@ const config: Config = {
{
title: "Community",
items: [
{
label: "Stack Overflow",
href: "https://stackoverflow.com/questions/tagged/configarr",
},
{
label: "YouTube",
href: "https://www.youtube.com/@raydak-labs",
},
{
label: "German Discord (UsenetDE)",
href: "https://discord.gg/Z2wTmrmFgn",
},
{
label: "TRaSH-Guides",
href: "https://trash-guides.info/",
},
// {
// label: "Discord",
// href: "https://discordapp.com/invite/docusaurus",
Expand All @@ -158,6 +166,15 @@ const config: Config = {
label: "Raydak",
href: "https://raydak.de",
},

{
label: "Stack Overflow",
href: "https://stackoverflow.com/questions/tagged/configarr",
},
{
label: "YouTube",
href: "https://www.youtube.com/@raydak-labs",
},
],
},
],
Expand Down
44 changes: 40 additions & 4 deletions docs/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ import styles from "./styles.module.css";

type FeatureItem = {
title: string;
Svg: React.ComponentType<React.ComponentProps<"svg">>;
Svg?: React.ComponentType<React.ComponentProps<"svg">>;
imageUrl?: string;
imageAlt?: string;
description: JSX.Element;
};

Expand All @@ -26,15 +28,49 @@ const FeatureList: FeatureItem[] = [
{
title: "Automated Setup",
Svg: require("@site/static/img/undraw_docusaurus_react.svg").default,
description: <>Let Configarr handle the complex setup of your media applications. From Sonarr to Radarr, we've got you covered.</>,
description: (
<>
Let Configarr handle the complex setup of your media applications. From Sonarr,Radarr,Lidarr,Readarr, Whisparr: we've got you
covered!
</>
),
},
{
title: "TRaSH-Guides Support",
imageUrl: require("@site/static/img/trash_logo.webp").default, //"https://trash-guides.info/img/logo.png" ,
imageAlt: "Logo of TRaSH-Guides",
description: (
<>
Seamlessly integrate TRaSH-Guides into your workflow with robust support for its comprehensive documentation and automation tools.
Effortlessly configure QualityProfiles, CustomFormats, and other advanced settings to optimize your media management experience,
ensuring precise and efficient handling of your library.
</>
),
},
{
title: "Experimental support",
Svg: require("@site/static/img/experiment.svg").default,
description: (
<>
Explore cutting-edge features with experimental support for popular Arr tools like Readarr, Lidarr, and Whisparr. Stay ahead of the
curve by testing innovative functionalities designed to enhance your media automation and management capabilities.
</>
),
},
{
title: "Community Driven",
Svg: require("@site/static/img/undraw_docusaurus_react.svg").default,
description: (
<>Written for the community and working with the community to provide the best experience for managing your media stack!</>
),
},
];

function Feature({ title, Svg, description }: FeatureItem) {
function Feature({ title, Svg, description, imageUrl, imageAlt }: FeatureItem) {
return (
<div className={clsx("col col--4")}>
<div className="text--center">
<Svg className={styles.featureSvg} role="img" />
{Svg ? <Svg className={styles.featureSvg} role="img" /> : <img src={imageUrl} className={styles.featureSvg} alt={imageAlt} />}
</div>
<div className="text--center padding-horiz--md">
<Heading as="h3">{title}</Heading>
Expand Down
9 changes: 7 additions & 2 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import Heading from "@theme/Heading";
import Layout from "@theme/Layout";
import clsx from "clsx";

import Head from "@docusaurus/Head";
import styles from "./index.module.css";

function HomepageHeader() {
Expand All @@ -18,7 +19,7 @@ function HomepageHeader() {
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link className="button button--secondary button--lg" to="/docs/intro">
Configarr Tutorial - 5min ⏱️
Tutorial - 5min ⏱️
</Link>
</div>
</div>
Expand All @@ -28,8 +29,12 @@ function HomepageHeader() {

export default function Home(): JSX.Element {
const { siteConfig } = useDocusaurusContext();

return (
<Layout title={`${siteConfig.title}`} description="Arr automation made easy">
<Layout>
<Head>
<title>Configarr - Configuration Management Simplified</title>
</Head>
<HomepageHeader />
<main>
<HomepageFeatures />
Expand Down
7 changes: 7 additions & 0 deletions docs/static/img/experiment.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/trash_logo.webp
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/static/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
User-agent: *
Disallow:

0 comments on commit 6928f2b

Please sign in to comment.