mirror of
https://code.castopod.org/adaures/castopod.git
synced 2024-09-28 04:31:47 +02:00
docs: add open-graph meta tags + edit pages link
- rename castopod icons and logos - fix nlnet logo link - add castopod icon as logo - set twitter card to summary_large_image - update README.md
This commit is contained in:
parent
fa5b5f51a4
commit
b3888c2c7f
12
README.md
12
README.md
@ -1,14 +1,20 @@
|
|||||||
<h1 align="center">
|
<h1 align="center">
|
||||||
<a href="https://castopod.org/">
|
<a href="https://castopod.org/">
|
||||||
<img src="https://docs.castopod.org/images/logo-inline.svg" alt="Castopod" />
|
<img src="https://docs.castopod.org/images/castopod-logo-inline.svg" alt="Castopod" style="height:4rem;" />
|
||||||
</a>
|
</a>
|
||||||
</h1>
|
</h1>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
[![release-badge]][release] [![license-badge]][license] [![semantic-release-badge]][semantic-release] [![discord-badge]][discord] [![stars-badge]][stars]
|
[![release-badge]][release] [![license-badge]][license] [![semantic-release-badge]][semantic-release] [![discord-badge]][discord] [![stars-badge]][stars]
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
Castopod is a free and open-source podcast hosting solution made for podcasters
|
Castopod is a free and open-source podcast hosting solution made for podcasters
|
||||||
who want engage and interact with their audience.
|
who want engage and interact with their audience.
|
||||||
|
|
||||||
|
> **Note**
|
||||||
|
>
|
||||||
> Castopod is currently in **beta** but already quite stable and used by
|
> Castopod is currently in **beta** but already quite stable and used by
|
||||||
> podcasters around the world!
|
> 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
|
Love Castopod and would like to help? Check out the
|
||||||
[contribution guidelines](https://docs.castopod.org/contributing/guidelines) for
|
[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
|
⚠️ Note that **any** contribution made on a repository other than
|
||||||
[the original repository](https://code.castopod.org/ad-aures/castopod) will not
|
[the original repository](https://code.castopod.org/ad-aures/castopod) will not
|
||||||
@ -55,7 +61,7 @@ Castopod:
|
|||||||
|
|
||||||
<div style="display:flex;flex-wrap:wrap;column-gap:4rem;row-gap:2rem;">
|
<div style="display:flex;flex-wrap:wrap;column-gap:4rem;row-gap:2rem;">
|
||||||
<a href="https://adaures.com/" target="_blank" rel="noopener noreferrer"><img src="https://docs.castopod.org/images/sponsors/adaures.svg" alt="Ad Aures Logo" style="height:4rem;" /></a>
|
<a href="https://adaures.com/" target="_blank" rel="noopener noreferrer"><img src="https://docs.castopod.org/images/sponsors/adaures.svg" alt="Ad Aures Logo" style="height:4rem;" /></a>
|
||||||
<a href="https://nlnet.nl/project/Castopod/" target="_blank" rel="noopener noreferrer"><img src="https://docs.castopod.org/images/sponsors/adaures.svg" alt="NLnet Logo" style="height:4rem;" /></a>
|
<a href="https://nlnet.nl/project/Castopod/" target="_blank" rel="noopener noreferrer"><img src="https://docs.castopod.org/images/sponsors/nlnet.svg" alt="NLnet Logo" style="height:4rem;" /></a>
|
||||||
<a href="https://opencollective.com/castopod/contribute" target="_blank" rel="noopener noreferrer">Become a sponsor</a>
|
<a href="https://opencollective.com/castopod/contribute" target="_blank" rel="noopener noreferrer">Become a sponsor</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -3,20 +3,36 @@ import { defineConfig } from "vitepress";
|
|||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
title: "Castopod docs",
|
title: "Castopod docs",
|
||||||
description:
|
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",
|
srcDir: "src",
|
||||||
|
|
||||||
head: [
|
head: [
|
||||||
["link", { rel: "icon", type: "image/x-icon", href: "/favicon.ico" }],
|
["link", { rel: "icon", type: "image/x-icon", href: "/favicon.ico" }],
|
||||||
["meta", { name: "twitter:site", content: "@castopod" }],
|
["link", { rel: "canonical", href: "https://docs.castopod.org/" }],
|
||||||
["meta", { name: "twitter:card", content: "summary" }],
|
["meta", { name: "robots", content: "index, follow" }],
|
||||||
|
["meta", { property: "og:type", content: "website" }],
|
||||||
[
|
[
|
||||||
"meta",
|
"meta",
|
||||||
{
|
{
|
||||||
name: "twitter:image",
|
property: "og:image",
|
||||||
content: "https://docs.castopod.org/images/logo.png",
|
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",
|
"script",
|
||||||
{
|
{
|
||||||
@ -28,6 +44,12 @@ export default defineConfig({
|
|||||||
],
|
],
|
||||||
|
|
||||||
themeConfig: {
|
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: [
|
nav: [
|
||||||
{
|
{
|
||||||
text: "Home",
|
text: "Home",
|
||||||
@ -42,7 +64,6 @@ export default defineConfig({
|
|||||||
link: "https://github.com/ad-aures/castopod",
|
link: "https://github.com/ad-aures/castopod",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
|
||||||
sidebar: {
|
sidebar: {
|
||||||
"/": getGuideSidebar(),
|
"/": getGuideSidebar(),
|
||||||
},
|
},
|
||||||
|
@ -139,8 +139,8 @@ Repo</a>
|
|||||||
|
|
||||||
### Install with Docker
|
### Install with Docker
|
||||||
|
|
||||||
I you wish to use Docker to install Castopod, it is possible thanks to
|
If you wish to use Docker to install Castopod, it is possible thanks to
|
||||||
[Romain de Laage](https://podcastindex.social/web/@rdelaage@mamot.fr)!
|
[Romain de Laage](https://mamot.fr/@rdelaage)!
|
||||||
|
|
||||||
<a href="https://gitlab.utc.fr/picasoft/projets/services/castopod" target="_blank" rel="noopener noreferrer" class="inline-flex items-center px-4 py-2 mx-auto font-semibold text-center text-white rounded-md shadow gap-x-1 bg-[#1282d7] hover:no-underline hover:bg-[#0f6eb5]">Install
|
<a href="https://gitlab.utc.fr/picasoft/projets/services/castopod" target="_blank" rel="noopener noreferrer" class="inline-flex items-center px-4 py-2 mx-auto font-semibold text-center text-white rounded-md shadow gap-x-1 bg-[#1282d7] hover:no-underline hover:bg-[#0f6eb5]">Install
|
||||||
with
|
with
|
||||||
|
@ -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
|
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
|
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 vs Wordpress
|
||||||
|
|
||||||
Castopod is often referred to as "the Wordpress for podcasts" because of the
|
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
|
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
|
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
|
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
|
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
|
On the other hand, Castopod is meant to address the podcasters needs
|
||||||
specifically, focusing on podcasting, and nothing else. You don't need any
|
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
|
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
|
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
|
Each of these solutions differ from one another, you may compare with the
|
||||||
[list of features](#features).
|
[list of features](#features).
|
||||||
|
|
||||||
That being said, there are two main differences with any other podcasting
|
That being said, there are two main differences with other podcasting solutions:
|
||||||
solution:
|
|
||||||
|
|
||||||
- Castopod can be self-hosted and is the only solution that allows you to keep
|
- 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
|
full control over what you produce. Also, as it is open-source, you can even
|
||||||
@ -151,14 +150,14 @@ solution:
|
|||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Love Castopod and would like to help? Take a look at the following documentation
|
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
|
### Code of conduct
|
||||||
|
|
||||||
Castopod has adopted a Code of Conduct that we expect project participants to
|
Castopod has adopted a Code of Conduct that we expect project participants to
|
||||||
adhere to. Please read the
|
adhere to. Please read the
|
||||||
[CODE_OF_CONDUCT manual](https://code.castopod.org/ad-aures/castopod/-/blob/beta/CODE_OF_CONDUCT.md)
|
[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
|
### Contributing guide
|
||||||
|
|
||||||
|
5
docs/src/public/images/castopod-icon.svg
Normal file
5
docs/src/public/images/castopod-icon.svg
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 67 44">
|
||||||
|
<path d="M62.2 44H51.39s-1.13-2.41-1.6-3.26c-.45-.86-1.55-.82-1.55-.82H18.85s-1.07-.14-1.6.82c-.57.95-1.63 3.26-1.63 3.26H4.97A4.47 4.47 0 0 1 .5 39.56V4.47A4.47 4.47 0 0 1 4.94 0h57.23a4.47 4.47 0 0 1 4.47 4.44v35.09A4.44 4.44 0 0 1 62.21 44Z" fill="#009486"></path>
|
||||||
|
<path d="M18.45 9.51h30.2a9.34 9.34 0 0 1 9.4 9.44c0 5.18-4.22 9.4-9.4 9.4h-30.2a9.42 9.42 0 0 1 0-18.84Z" fill="#E7F9E4"></path>
|
||||||
|
<path d="M46.27 15.36a4.61 4.61 0 0 0-3.64 7.46s1.58-1.18 3.8-1.18c1.66 0 3.6 1.01 3.6 1.01a4.61 4.61 0 0 0-3.76-7.29ZM20.73 15.36a4.61 4.61 0 0 0-3.77 7.3s1.94-1.02 3.6-1.02c2.23 0 3.8 1.18 3.8 1.18a4.61 4.61 0 0 0-3.64-7.45Z" fill="#009486"></path>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 728 B |
Before Width: | Height: | Size: 3.9 KiB After Width: | Height: | Size: 3.9 KiB |
Binary file not shown.
Before Width: | Height: | Size: 2.7 KiB |
BIN
docs/src/public/images/open-graph.jpg
Normal file
BIN
docs/src/public/images/open-graph.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 147 KiB |
Loading…
Reference in New Issue
Block a user