matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: migrating from hugo-theme-learn to hugo-theme-relearn

Browse Source
This commit is contained in:
John Livingston 2024-08-29 16:04:17 +02:00
parent 2824bd1e38
commit 75925b1117
No known key found for this signature in database
GPG Key ID: B17B5640CE66CDBC
9 changed files with 34 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/gh-pages.yml vendored
View File

@ -33,7 +33,7 @@ jobs:
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.80.0'
hugo-version: '0.132.2'
extended: true
- name: Generate documentation translations

6
.gitmodules vendored
View File

@ -2,6 +2,6 @@
#
# SPDX-License-Identifier: AGPL-3.0-only
[submodule "documentation/themes/hugo-theme-learn"]
path = support/documentation/themes/hugo-theme-learn
url = https://github.com/matcornic/hugo-theme-learn.git
[submodule "support/documentation/themes/hugo-theme-relearn"]
path = support/documentation/themes/hugo-theme-relearn
url = https://github.com/McShelby/hugo-theme-relearn.git

52
support/documentation/config.toml
View File

@ -6,21 +6,19 @@ baseURL = "http://localhost:1313/peertube-plugin-livechat/" # this will be overr
languageCode = "en-us"
defaultContentLanguage = "en"
title = "Peertube plugin livechat"
theme = 'hugo-theme-learn'
theme = 'hugo-theme-relearn'
[outputs]
home = [ "HTML", "RSS", "JSON"]
home = [ "HTML", "RSS", "SEARCH"]
[params]
author = "John Livingston"
description = "Peertube plugin livechat documentation"
showVisitedLinks = true
disableSearch = false
disableLandingPageButton = false
disableLandingPageButton = true
themeVariant = "red"
landingPageURL = "/peertube-plugin-livechat/"
landingPageName = "<i class='fas fa-home'></i> Home"
custom_css = ["css/livechatdoc.css"]
[params.author]
name = "John Livingston"
[[menu.shortcuts]]
name = "<i class='fab fa-github'></i> Github repository"
@ -40,181 +38,143 @@ weight = 20
[Languages.ar]
languageName = "العربية"
landingPageURL = "/peertube-plugin-livechat/ar/"
contentDir = "content/translations/ar"
[Languages.ca]
languageName = "Català"
landingPageURL = "/peertube-plugin-livechat/ca/"
contentDir = "content/translations/ca"
[Languages.cs]
languageName = "Čeština"
landingPageURL = "/peertube-plugin-livechat/cs/"
contentDir = "content/translations/cs"
[Languages.de]
title = "Peertube Plugin Livechat Dokumentation"
languageName = "Deutsch"
landingPageName = "<i class='fas fa-home'></i> Home"
landingPageURL = "/peertube-plugin-livechat/de/"
contentDir = "content/translations/de"
[Languages.el]
languageName = "ελληνικά"
landingPageURL = "/peertube-plugin-livechat/el/"
contentDir = "content/translations/el"
[Languages.eo]
languageName = "Esperanto"
landingPageURL = "/peertube-plugin-livechat/eo/"
contentDir = "content/translations/eo"
[Languages.es]
languageName = "Español"
landingPageURL = "/peertube-plugin-livechat/es/"
contentDir = "content/translations/es"
[Languages.eu]
languageName = "Euskara"
landingPageURL = "/peertube-plugin-livechat/eu/"
contentDir = "content/translations/eu"
[Languages.fa]
languageName = "فارسی"
landingPageURL = "/peertube-plugin-livechat/fa/"
contentDir = "content/translations/fa"
[Languages.fi]
languageName = "Suomi"
landingPageURL = "/peertube-plugin-livechat/fi/"
contentDir = "content/translations/fi"
[Languages.fr]
title = "Documentation plugin Peertube livechat"
languageName = "Français"
landingPageName = "<i class='fas fa-home'></i> Accueil"
landingPageURL = "/peertube-plugin-livechat/fr/"
contentDir = "content/translations/fr"
[Languages.gd]
languageName = "Gàidhlig"
landingPageURL = "/peertube-plugin-livechat/gd/"
contentDir = "content/translations/gd"
[Languages.gl]
languageName = "Galego"
landingPageURL = "/peertube-plugin-livechat/gl/"
contentDir = "content/translations/gl"
[Languages.hr]
languageName = "Hrvatski"
landingPageURL = "/peertube-plugin-livechat/hr/"
contentDir = "content/translations/hr"
[Languages.hu]
languageName = "Magyar"
landingPageURL = "/peertube-plugin-livechat/hu/"
contentDir = "content/translations/hu"
[Languages.is]
languageName = "Íslenska"
landingPageURL = "/peertube-plugin-livechat/is/"
contentDir = "content/translations/is"
[Languages.it]
languageName = "Italiano"
landingPageURL = "/peertube-plugin-livechat/it/"
contentDir = "content/translations/it"
[Languages.ja]
title = "PeerTube ライブチャットプラグイン"
languageName = "日本語バージョン"
landingPageName = "<i class='fas fa-home'></i> Home"
landingPageURL = "/peertube-plugin-livechat/ja/"
contentDir = "content/translations/ja"
[Languages.kab]
languageName = "Taqbaylit"
landingPageURL = "/peertube-plugin-livechat/ka/"
contentDir = "content/translations/kab"
[Languages.nb]
languageName = "Norsk bokmål"
landingPageURL = "/peertube-plugin-livechat/nb/"
contentDir = "content/translations/nb"
[Languages.nl]
languageName = "Nederlands"
landingPageURL = "/peertube-plugin-livechat/nl/"
contentDir = "content/translations/nl"
[Languages.nn]
languageName = "Norsk nynorsk"
landingPageURL = "/peertube-plugin-livechat/nn/"
contentDir = "content/translations/nn"
[Languages.oc]
languageName = "Occitan"
landingPageURL = "/peertube-plugin-livechat/oc/"
contentDir = "content/translations/oc"
[Languages.pl]
languageName = "Polski"
landingPageURL = "/peertube-plugin-livechat/pl/"
contentDir = "content/translations/pl"
[Languages.pt]
languageName = "uguês"
landingPageURL = "/peertube-plugin-livechat/pt/"
contentDir = "content/translations/pt"
[Languages.ru]
languageName = "Pусский"
landingPageURL = "/peertube-plugin-livechat/ru/"
contentDir = "content/translations/ru"
[Languages.sq]
languageName = "Shqip"
landingPageURL = "/peertube-plugin-livechat/sq/"
contentDir = "content/translations/sq"
[Languages.sv]
languageName = "Svenska"
landingPageURL = "/peertube-plugin-livechat/sv/"
contentDir = "content/translations/sv"
[Languages.th]
languageName = "ไทย"
landingPageURL = "/peertube-plugin-livechat/th/"
contentDir = "content/translations/th"
[Languages.tr]
languageName = "Türkçe"
landingPageURL = "/peertube-plugin-livechat/tr/"
contentDir = "content/translations/tr"
[Languages.tok]
languageName = "Toki Pona"
landingPageURL = "/peertube-plugin-livechat/to/"
contentDir = "content/translations/tok"
[Languages.uk]
languageName = "украї́нська мо́ва"
landingPageURL = "/peertube-plugin-livechat/uk/"
contentDir = "content/translations/uk"
[Languages.vi]
languageName = "Tiếng Việt"
landingPageURL = "/peertube-plugin-livechat/vi/"
contentDir = "content/translations/vi"
[Languages.zh-Hans]
languageName = "简体中文（中国）"
landingPageURL = "/peertube-plugin-livechat/zh-Hans/"
contentDir = "content/translations/zh-Hans"
[Languages.zh-Hant]
languageName = "繁體中文（台灣"
landingPageURL = "/peertube-plugin-livechat/zh-Hant/"
contentDir = "content/translations/zh-Hant"

5
support/documentation/content/en/_index.md
View File

@ -1,3 +1,8 @@
---
title: "Peertube livechat"
description: "Peertube plugin livechat documentation"
---
# PeerTube plugin livechat
{{% notice tip %}}

5
support/documentation/content/en/contributing/document/_index.md
View File

@ -17,7 +17,10 @@ The documentation source code is in the `support/documentation/content` folder.
The documentation is generated using [Hugo](https://gohugo.io/).
You have to install it on your computer if you want to preview your work.
The used theme is [hugo-theme-learn](https://learn.netlify.app/).
The minimum required version for Hugo is 0.121.0.
It was tested using version 0.132.2.
The used theme is [hugo-theme-relearn](https://mcshelby.github.io/hugo-theme-relearn).
You should read its documentation before starting editing the documentation.
When a new plugin version is released, or when documentation is updated, plugin maintainers will merge the `main` branch to the `documentation` branch.

23
support/documentation/static/css/livechatdoc.css → support/documentation/layouts/partials/custom-header.html
View File

@ -1,16 +1,13 @@
/*
* SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
<style>
:root {
/* more contrast than the default theme. */
--MAIN-TEXT-color:#000; /* Color of text by default */
--MAIN-TITLES-TEXT-color: #222; /* Color of titles h2-h3-h4-h5 */
--MAIN-TITLES-H1-color: #222; /* text color of h1 titles */
--MAIN-LINK-color:#f31c1c; /* Color of links */
--MAIN-LINK-HOVER-color:#d01616; /* Color of hovered links */
--MAIN-ANCHOR-color: #f31c1c; /* color of anchors on titles */
/* --MAIN-BG-color: rgba( 255, 255, 255, 1 ); /* color of text by default */
--MENU-HOME-LINK-color: #fff; /* Color of the home button text */
--MENU-HOME-LINK-HOVER-color: #e6e6e6; /* Color of the hovered home button text */
@ -18,9 +15,9 @@
--MENU-HEADER-BG-color:#dc1010; /* Background color of menu header */
--MENU-HEADER-BORDER-color:#e23131; /*Color of menu header border */
--MENU-SEARCH-color: #fab0b0; /* Override search field icons color */
--MENU-SEARCH-BG-color:#b90000; /* Search field background color (by default borders + icons) */
--MENU-SEARCH-BOX-color: #ef2020; /* Override search field border color */
--MENU-SEARCH-BOX-ICONS-color: #fab0b0; /* Override search field icons color */
--MENU-SEARCH-BORDER-color: #ef2020; /* Override search field border color */
--MENU-SECTIONS-ACTIVE-BG-color:#2b2020; /* Background color of the active section and its childs */
--MENU-SECTIONS-BG-color:#312525; /* Background color of other sections */
@ -30,7 +27,7 @@
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: #fff; /* Color of background for the active category (only) */
--MENU-VISITED-color: #ff3333; /* Color of 'page visited' icons in menu */
--MENU-SECTION-HR-color: #2b2020; /* Color of <hr> separator in menu */
--MENU-SECTION-SEPARATOR-color: #2b2020; /* Color of <hr> separator in menu */
}
div.notices p {
@ -43,8 +40,10 @@ div.notices p {
So we will underline links, and let the a.highlight animation double underline on hovering.
Si hugo-theme.css, a.highlight, for more information on about it is done.
*/
#body a.highlight,
#body a.highlight:hover,
#body a.highlight:focus {
body a.highlight,
body a.highlight:hover,
body a.highlight:focus {
text-decoration: underline;
}
</style>

3
support/documentation/layouts/partials/custom-header.html.license Normal file
View File

@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
SPDX-License-Identifier: AGPL-3.0-only

1
support/documentation/themes/hugo-theme-learn

@ -1 +0,0 @@
Subproject commit e817f53d690d35f181c896e0e320cb40f797e88c

1
support/documentation/themes/hugo-theme-relearn Submodule

@ -0,0 +1 @@
Subproject commit 8791108273a9f7f58ed3f33941d1fe8f0117c594