xiaoxue_admin
/
RSSHub
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: rending docs route component

This commit is contained in:
DIYgod 2024-03-09 17:53:08 +08:00
parent bb70716973
commit ca82a0b2d6
No known key found for this signature in database
1 changed files with 18 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
website/src/components/Route.tsx
View File

@ -2,38 +2,19 @@ import MarkdownIt from 'markdown-it';
import Badge from './Badge';
import Translate from '@docusaurus/Translate';
import Link from '@docusaurus/Link';
import type { Route } from '../../../lib/types';
export default function Route({
author = 'DIYgod',
path = '',
example = '',
paramsDesc = 'N/A',
anticrawler = null,
supportBT = null,
supportPodcast = null,
supportScihub = null,
radar = null,
configRequired = null,
puppeteer = null,
notOperational = null,
namespace,
data,
children = null,
}: {
author?: string;
path: string;
example?: string;
paramsDesc?: string;
anticrawler?: boolean;
supportBT?: boolean;
supportPodcast?: boolean;
supportScihub?: boolean;
radar?: boolean;
configRequired?: boolean;
puppeteer?: boolean;
notOperational?: boolean;
namespace: string,
data: Route;
children?: JSX.Element | JSX.Element[];
}): JSX.Element {
const demoUrl = 'https://rsshub.app' + example;
const paramMatch = path.match(/(?<=:).*?(?=\/|$)/g);
const demoUrl = 'https://rsshub.app' + data.example;
const paramMatch = data.path.match?.(/(?<=:).*?(?=\/|$)/g);
const renderMarkdown = (item, inline = true) => {
const md = new MarkdownIt({
@ -43,28 +24,23 @@ export default function Route({
};
return (
<div className={`routeBlock ${notOperational ? "notOperational" : ""}`} id={path}>
<div className='routeBlock' id={namespace + JSON.stringify(data.path)}>
<p className="badges">
{notOperational && (
<Link to={`https://github.com/search?q=${encodeURIComponent('repo:DIYgod/RSSHub')}+${encodeURIComponent(`"${path}"`)}&type=issues`}>
<Badge type="caution"><Translate id="badge.notOperational" /></Badge>
</Link>
)}
{anticrawler && (
{data.features.antiCrawler && (
<Link to="/faq">
<Badge type="caution"><Translate id="badge.anticrawler" /></Badge>
</Link>
)}
{supportBT && <Badge type="tip"><Translate id="badge.supportBT" /></Badge>}
{supportPodcast && <Badge type="tip"><Translate id="badge.supportPodcast" /></Badge>}
{supportScihub && <Badge type="tip"><Translate id="badge.supportSciHub" /></Badge>}
{puppeteer && <Badge type="warning"><Translate id="badge.puppeteer" /></Badge>}
{configRequired && (
{data.features.supportBT && <Badge type="tip"><Translate id="badge.supportBT" /></Badge>}
{data.features.supportPodcast && <Badge type="tip"><Translate id="badge.supportPodcast" /></Badge>}
{data.features.supportScihub && <Badge type="tip"><Translate id="badge.supportSciHub" /></Badge>}
{data.features.requirePuppeteer && <Badge type="warning"><Translate id="badge.puppeteer" /></Badge>}
{data.features.requireConfig && (
<Link to="/install/config#route-specific-configurations">
<Badge type="warning"><Translate id="badge.configRequired" /></Badge>
</Link>
)}
{radar && (
{data.radar && (
<Link to="/usage#radar">
<Badge type="tip"><Translate id="badge.radar" /></Badge>
</Link>
@ -72,7 +48,7 @@ export default function Route({
</p>
<p className="author">
<Translate id="route.author" />
{author.split(' ').map((uid) => (
{data.maintainers.map((uid) => (
<Link to={`https://github.com/${uid}`} key={uid}>
@{uid}{' '}
</Link>
@ -86,7 +62,7 @@ export default function Route({
<img loading="lazy" src={`https://img.shields.io/website.svg?label=&url=${encodeURIComponent(demoUrl)}&cacheSeconds=7200`} />
</p>
<p className="path">
<Translate id="route.path" /><code>{path}</code>
<Translate id="route.path" /><code>{data.path}</code>
</p>
{paramMatch ? (
<div>
@ -100,7 +76,7 @@ export default function Route({
'*': <Translate id="route.parameter.zeroOrMore" />,
'+': <Translate id="route.parameter.oneOrMore" />,
}[item[item.length - 1]] || <Translate id="route.parameter.required" /> }
<Translate id="route.dash" /><span dangerouslySetInnerHTML={{ __html: renderMarkdown(paramsDesc[index]) }}></span>
<Translate id="route.dash" /><span dangerouslySetInnerHTML={{ __html: renderMarkdown(data.parameters[item.replace(/:|\?|\+|\*/g, '')] || '') }}></span>
</li>
))}
</ul>