garrettmills/commafeed
1
0
Fork 0
forked from Archives/Athou_commafeed
Code Pull Requests Activity

add reference to the custom css documentation

Browse Source
This commit is contained in:
Athou
2025-05-12 08:30:47 +02:00
parent e3b6be0cd0
commit 168bcd3a37
33 changed files with 155 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
.github/workflows/ci.yml vendored
View File

@@ -44,18 +44,27 @@ jobs:
run: mvn --batch-mode --no-transfer-progress install -Pnative -P${{ matrix.database }} -DskipTests=${{ matrix.os == 'windows-latest' && matrix.database != 'h2' }}
# Build pages
- name: Copy generated markdown documentation to /documentation
run: mkdir documentation && cp ./commafeed-server/target/quarkus-generated-doc/config/commafeed-server.md ./documentation/README.md
- name: Create pages directory structure
run: mkdir -p target/pages/documentation/custom-css
- name: Generate pages
uses: wranders/markdown-to-pages-action@8d8a750832932ac785f5424c8c5543aa0b26bb9a # v1
- name: Convert readme file to html
uses: jaywcjlove/markdown-to-html-cli@v5.0.3
with:
token: ${{ secrets.GITHUB_TOKEN }}
out_path: target/pages
files: |-
README.md
documentation/README.md
source: README.md
output: target/pages/index.html
- name: Convert config documentation to html
uses: jaywcjlove/markdown-to-html-cli@v5.0.3
with:
source: commafeed-server/target/quarkus-generated-doc/config/commafeed-server.md
output: target/pages/documentation/index.html
- name: Convert custom css documentation to html
uses: jaywcjlove/markdown-to-html-cli@v5.0.3
with:
source: documentation/CUSTOMCSS.md
output: target/pages/documentation/custom-css/index.html
# Upload artifacts
- name: Upload cross-platform app
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4

1
README.md
View File

@@ -17,6 +17,7 @@ Google Reader inspired self-hosted RSS reader, based on Quarkus and React/TypeSc
- REST API
- Fever-compatible API for native mobile apps
- Can automatically mark articles as read based on user-defined rules
- Highly customizable with [custom CSS](https://athou.github.io/commafeed/documentation/custom-css) and JavaScript
- [Browser extension](https://github.com/Athou/commafeed-browser-extension)
- Compiles to native code for blazing fast startup and low memory usage
- Supports 4 databases

1
commafeed-client/src/app/constants.ts
View File

@@ -108,5 +108,6 @@ export const Constants = {
delay: 500,
},
browserExtensionUrl: "https://github.com/Athou/commafeed-browser-extension",
customCssDocumentationUrl: "https://athou.github.io/commafeed/documentation/custom-css",
bitcoinWalletAddress: "1dymfUxqCWpyD7a6rQSqNy4rLVDBsAr5e",
}

6
commafeed-client/src/components/code/CodeEditor.tsx
View File

@@ -4,6 +4,7 @@ import { useMobile } from "hooks/useMobile"
import type { ReactNode } from "react"
interface CodeEditorProps {
label?: ReactNode
description?: ReactNode
language: "css" | "javascript"
value?: string
@@ -19,7 +20,8 @@ export function CodeEditor(props: CodeEditorProps) {
autosize
minRows={4}
maxRows={15}
label={props.description}
label={props.label}
description={props.description}
styles={{
input: {
fontFamily: "monospace",
@@ -29,7 +31,7 @@ export function CodeEditor(props: CodeEditorProps) {
onChange={e => props.onChange(e.currentTarget.value)}
/>
) : (
<Input.Wrapper label={props.description}>
<Input.Wrapper label={props.label} description={props.description}>
<RichCodeEditor height="30vh" language={props.language} value={props.value} onChange={props.onChange} />
</Input.Wrapper>
)

21
commafeed-client/src/components/settings/CustomCodeSettings.tsx
View File

@@ -1,7 +1,8 @@
import { Trans } from "@lingui/react/macro"
import { Box, Button, Group, Stack } from "@mantine/core"
import { Anchor, Box, Button, Group, Stack } from "@mantine/core"
import { useForm } from "@mantine/form"
import { client, errorToStrings } from "app/client"
import { Constants } from "app/constants"
import { redirectToSelectedSource } from "app/redirect/thunks"
import { useAppDispatch, useAppSelector } from "app/store"
import { Alert } from "components/Alert"
@@ -57,13 +58,27 @@ export function CustomCodeSettings() {
<form onSubmit={form.onSubmit(saveCustomCode.execute)}>
<Stack>
<CodeEditor
description={<Trans>Custom CSS rules that will be applied</Trans>}
label={<Trans>Custom CSS rules that will be applied</Trans>}
description={
<Trans>
<span>See </span>
<Anchor
href={Constants.customCssDocumentationUrl}
target="_blank"
rel="noreferrer"
style={{ fontSize: "inherit" }}
>
here
</Anchor>
<span> for more information.</span>
</Trans>
}
language="css"
{...form.getInputProps("customCss")}
/>
<CodeEditor
description={<Trans>Custom JS code that will be executed on page load</Trans>}
label={<Trans>Custom JS code that will be executed on page load</Trans>}
language="javascript"
{...form.getInputProps("customJs")}
/>

4
commafeed-client/src/locales/ar/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0> هل تحتاج إلى حساب؟ </0> <1> اشترك! </ 1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/ca/messages.po
View File

@@ -33,6 +33,10 @@ msgstr "<0>Ei,</0><1> sóc la Jérémie de Bèlgica i fa més de 10 anys que tre
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Necessites un compte?</0><1>Registreu-vos!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/cs/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Potřebujete účet?</0><1>Zaregistrujte se!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/cy/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Angen cyfrif?</0><1>Ymunwch!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/da/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Har du brug for en konto?</0><1>Tilmeld dig!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/de/messages.po
View File

@@ -33,6 +33,10 @@ msgstr "<0>Hey,</0><1>Ich bin Jérémie aus Belgien und arbeite seit über 10 Ja
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Benötigen Sie ein Konto?</0><1>Hier geht's zur Registrierung!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/en/messages.po
View File

@@ -33,6 +33,10 @@ msgstr "<0>Hey,</0><1>I'm Jérémie from Belgium and I've been working on CommaF
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Need an account?</0><1>Sign up!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr "<0>See </0><1>here</1><2> for more information.</2>"
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/es/messages.po
View File

@@ -34,6 +34,10 @@ msgstr "<0>Hola,</0><1>Soy Jérémie de Bélgica y he estado trabajando en Comma
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>¿Necesitas una cuenta?</0><1>¡Regístrate!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/fa/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>به یک حساب نیاز دارید؟</0><1>ثبت نام کنید!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/fi/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Tarvitsetko tilin?</0><1>Rekisteröidy!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/fr/messages.po
View File

@@ -33,6 +33,10 @@ msgstr "<0>Salut,</0><1>Je m'appelle Jérémie, je suis belge, et je développe
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Besoin d'un compte ?</0><1>Enregistrez-vous !</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/gl/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Necesitas unha conta?</0><1>Rexístrate!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/hu/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Fiókra van szüksége?</0><1>Regisztráljon!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/id/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Butuh akun?</0><1>Daftar!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/it/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Hai bisogno di un account?</0><1>Registrati!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/ja/messages.po
View File

@@ -33,6 +33,10 @@ msgstr "<0>こんにちは、</0><1>私はベルギーのジェレミーです
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>アカウントが必要ですか?</0><1>サインアップ!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/ko/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>계정이 필요하십니까?</0><1>가입하세요!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/ms/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Perlukan akaun?</0><1>Daftar!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/nb/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Trenger du en konto?</0><1>Registrer deg!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/nl/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Een account nodig?</0><1>Meld je aan!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/nn/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Trenger du en konto?</0><1>Registrer deg!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/pl/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Potrzebujesz konta?</0><1>Zarejestruj się!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/pt/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Precisa de uma conta?</0><1>Inscreva-se!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/ru/messages.po
View File

@@ -33,6 +33,10 @@ msgstr "<0>Здравствуйте,</0><1>Я Жереми из Бельгии,
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Нужен аккаунт?</0><1>Зарегистрируйтесь!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/sk/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Potrebujete účet?</0><1>Zaregistrujte sa!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/sv/messages.po
View File

@@ -33,6 +33,10 @@ msgstr ""
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Behöver du ett konto?</0><1>Registrera dig!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/tr/messages.po
View File

@@ -33,6 +33,10 @@ msgstr "<0>Merhaba,</0><1>Ben Belçika'dan Jérémie ve 10 yıldır boş zamanla
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>Bir hesaba mı ihtiyacınız var?</0><1>Kaydolun!</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"

4
commafeed-client/src/locales/zh/messages.po
View File

@@ -33,6 +33,10 @@ msgstr "<0>您好,</0><1>我是来自比利时的Jérémie，已经在业余时
msgid "<0>Need an account?</0><1>Sign up!</1>"
msgstr "<0>需要一个帐户？</0><1>注册！</1>"
#: src/components/settings/CustomCodeSettings.tsx
msgid "<0>See </0><1>here</1><2> for more information.</2>"
msgstr ""
#: src/pages/app/AboutPage.tsx
#: src/components/header/ProfileMenu.tsx
msgid "About"