diff --git a/README.md b/README.md index 2ee1d84d..1c42ea8d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,20 @@

- Castopod + Castopod

+
+ [![release-badge]][release] [![license-badge]][license] [![semantic-release-badge]][semantic-release] [![discord-badge]][discord] [![stars-badge]][stars] +
+ Castopod is a free and open-source podcast hosting solution made for podcasters who want engage and interact with their audience. +> **Note** +> > Castopod is currently in **beta** but already quite stable and used by > podcasters around the world! @@ -28,7 +34,7 @@ please contact us directly by email at Love Castopod and would like to help? Check out the [contribution guidelines](https://docs.castopod.org/contributing/guidelines) for -this project, everything should be there! +this project. ⚠️ Note that **any** contribution made on a repository other than [the original repository](https://code.castopod.org/ad-aures/castopod) will not @@ -55,7 +61,7 @@ Castopod:
Ad Aures Logo - NLnet Logo + NLnet Logo Become a sponsor
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index bd189237..860fa071 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -3,20 +3,36 @@ import { defineConfig } from "vitepress"; export default defineConfig({ title: "Castopod docs", description: - "Get started with Castopod, install it, contribute and learn more!", + "Check out the Castopod documentation! Install your own free & open-source podcast host, help make it better by contributing, or simply learn more about Castopod!", srcDir: "src", head: [ ["link", { rel: "icon", type: "image/x-icon", href: "/favicon.ico" }], - ["meta", { name: "twitter:site", content: "@castopod" }], - ["meta", { name: "twitter:card", content: "summary" }], + ["link", { rel: "canonical", href: "https://docs.castopod.org/" }], + ["meta", { name: "robots", content: "index, follow" }], + ["meta", { property: "og:type", content: "website" }], [ "meta", { - name: "twitter:image", - content: "https://docs.castopod.org/images/logo.png", + property: "og:image", + content: "https://docs.castopod.org/images/open-graph.jpg", }, ], + ["meta", { property: "og:image:type", content: "image/jpeg" }], + ["meta", { property: "og:image:width", content: "1200" }], + ["meta", { property: "og:image:height", content: "630" }], + [ + "meta", + { + property: "og:image:alt", + content: + "Castopod mascot waving hello and hoding a browser showcasing the Castopod documentation.", + }, + ], + ["meta", { property: "og:url", content: "https://docs.castopod.org/" }], + ["meta", { name: "twitter:site", content: "@castopod" }], + ["meta", { name: "twitter:card", content: "summary_large_image" }], + ["meta", { name: "twitter:creator", content: "@ad_aures" }], [ "script", { @@ -28,6 +44,12 @@ export default defineConfig({ ], themeConfig: { + logo: "/images/castopod-icon.svg", + lastUpdated: "Last Updated", + repo: "https://code.castopod.org/ad-aures/castopod", + docsDir: "docs/src", + docsBranch: "develop", + editLinks: true, nav: [ { text: "Home", @@ -42,7 +64,6 @@ export default defineConfig({ link: "https://github.com/ad-aures/castopod", }, ], - sidebar: { "/": getGuideSidebar(), }, diff --git a/docs/src/getting-started/install.md b/docs/src/getting-started/install.md index 4fadfa08..5a621098 100644 --- a/docs/src/getting-started/install.md +++ b/docs/src/getting-started/install.md @@ -139,8 +139,8 @@ Repo ### Install with Docker -I you wish to use Docker to install Castopod, it is possible thanks to -[Romain de Laage](https://podcastindex.social/web/@rdelaage@mamot.fr)! +If you wish to use Docker to install Castopod, it is possible thanks to +[Romain de Laage](https://mamot.fr/@rdelaage)! Install with diff --git a/docs/src/index.md b/docs/src/index.md index a82ce855..197b52b9 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -83,14 +83,14 @@ This project is pushed by the open-source community, and specifically by the We believe that a solution is not necessarily right for everyone, it highly depends on your needs. So, here are comparisons with other tools to help you to -gauge whether Castopod is the right fit for you. +gauge whether Castopod is the right fit for you. ### Castopod vs Wordpress Castopod is often referred to as "the Wordpress for podcasts" because of the similarities between the two. In some ways this is true. And actually, Castopod was greatly inspired by the Wordpress ecosystem, seeing the ease of adoption -from the community and the number of websites running it. +from the community and the number of websites running it. Just like Wordpress, Castopod is free & open source, built using PHP with a MySQL database and is packaged in a way that you can easily install on most web @@ -102,7 +102,7 @@ website online. On the other hand, Castopod is meant to address the podcasters needs specifically, focusing on podcasting, and nothing else. You don't need any -plugin to get you started on your podcasting journey. +plugin to get you started on your podcasting journey. This allows optimizing the processes specific to podcasting: ranging from the creation of your podcasts and the publication of new episodes all the way to @@ -137,8 +137,7 @@ Podcasting 2.0 wagon just like Castopod! Each of these solutions differ from one another, you may compare with the [list of features](#features). -That being said, there are two main differences with any other podcasting -solution: +That being said, there are two main differences with other podcasting solutions: - Castopod can be self-hosted and is the only solution that allows you to keep full control over what you produce. Also, as it is open-source, you can even @@ -151,14 +150,14 @@ solution: ## Contributing Love Castopod and would like to help? Take a look at the following documentation -to get you started. +to get you started. ### Code of conduct Castopod has adopted a Code of Conduct that we expect project participants to adhere to. Please read the [CODE_OF_CONDUCT manual](https://code.castopod.org/ad-aures/castopod/-/blob/beta/CODE_OF_CONDUCT.md) -so that you can understand what actions will and will not be tolerated. +so that you can understand what actions will and will not be tolerated. ### Contributing guide diff --git a/docs/src/public/images/castopod-icon.svg b/docs/src/public/images/castopod-icon.svg new file mode 100644 index 00000000..22810aab --- /dev/null +++ b/docs/src/public/images/castopod-icon.svg @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/docs/src/public/images/logo-inline.svg b/docs/src/public/images/castopod-logo-inline.svg similarity index 100% rename from docs/src/public/images/logo-inline.svg rename to docs/src/public/images/castopod-logo-inline.svg diff --git a/docs/src/public/images/logo.png b/docs/src/public/images/logo.png deleted file mode 100644 index b15f1baf..00000000 Binary files a/docs/src/public/images/logo.png and /dev/null differ diff --git a/docs/src/public/images/open-graph.jpg b/docs/src/public/images/open-graph.jpg new file mode 100644 index 00000000..b2a5f1d2 Binary files /dev/null and b/docs/src/public/images/open-graph.jpg differ