mirror of
https://github.com/DIYgod/RSSHub.git
synced 2025-12-04 19:59:54 +08:00
eb79456f40
* docs: support parameter suffix `*` `*` denotes a zero or more parameter matches, so the parameter including `*` is optional. (https://github.com/pillarjs/path-to-regexp#zero-or-more) * docs: mention the parameter suffix `*` * docs: support parameter suffix `+` * docs: add document of parameter suffixs * docs: fix having / at the end of parameter * docs: add missing changes in en docs * docs: typo Co-authored-by: TonyRL <TonyRL@users.noreply.github.com>
84 lines
2.6 KiB
Vue
84 lines
2.6 KiB
Vue
<template>
|
|
<div class="routeBlock" :id="path">
|
|
<p class="badge">
|
|
<Badge text="support BT" type="tip" vertical="middle" v-if="supportBT"/> <Badge text="support podcast" type="tip" vertical="middle" v-if="supportPodcast"/> <a target="_blank" href="/en/faq.html" v-if="anticrawler"><Badge text="strict anti-crawler policy" vertical="middle" type="warn"/></a> <a target="_blank" href="https://github.com/DIYgod/RSSHub-Radar" v-if="radar"><Badge text="support browser extension" vertical="middle" type="tip"/></a> <a target="_blank" href="https://github.com/Cay-Zhang/RSSBud" v-if="rssbud"><Badge text="support rssbud" vertical="middle" type="tip"/></a> <a target="_blank" href="https://docs.rsshub.app/en/install/" v-if="selfhost"><Badge text="self-host only" vertical="middle" type="warn"/></a>
|
|
</p>
|
|
<p class="author">
|
|
Author: <a v-for="uid in author.split(' ')" :href="`https://github.com/${uid}`" target="_blank"> @{{ uid }} </a>
|
|
</p>
|
|
<p class="example">
|
|
<span>Example:</span> <a :href="demoUrl" target="_blank">{{demoUrl}}</a> <img :src="'https://img.shields.io/website?label=status&style=flat-square&url=' + encodeURIComponent(encodeURI(demoUrl))">
|
|
</p>
|
|
<p class="path">
|
|
Route: <code>{{ path }}</code>
|
|
</p>
|
|
<div v-if="path.match(/(?<=:).*?(?=\/|$)/g)">
|
|
<p>
|
|
Parameters:
|
|
</p>
|
|
<ul><li class="params" v-for="(item, index) in path.match(/(?<=:).*?(?=\/|$)/g)"><code>{{item.replace(/:|\?|\+|\*/g,'')}}</code>, {{{'?':'optional','*':'zero or more','+':'one or more'}[item[item.length-1]]||'required'}} - <span v-html="renderMarkdown(paramsDesc[index])"></span></li></ul>
|
|
</div>
|
|
<div v-else><p>Parameters: N/A</p></div>
|
|
<slot></slot>
|
|
</div>
|
|
</template>
|
|
<script>
|
|
export default {
|
|
props: {
|
|
author: {
|
|
type: String,
|
|
default: 'DIYgod'
|
|
},
|
|
path: {
|
|
type: String,
|
|
required: true
|
|
},
|
|
example: {
|
|
type: String,
|
|
required: true
|
|
},
|
|
paramsDesc: {
|
|
type: [Array, String],
|
|
default: 'N/A'
|
|
},
|
|
anticrawler: {
|
|
type: String,
|
|
default: null
|
|
},
|
|
supportBT: {
|
|
type: String,
|
|
default: null
|
|
},
|
|
supportPodcast: {
|
|
type: String,
|
|
default: null
|
|
},
|
|
radar: {
|
|
type: String,
|
|
default: null
|
|
},
|
|
rssbud: {
|
|
type: String,
|
|
default: null
|
|
},
|
|
selfhost: {
|
|
type: String,
|
|
default: null
|
|
},
|
|
},
|
|
methods: {
|
|
renderMarkdown(item, inline = true) {
|
|
const md = require('markdown-it')({
|
|
html: true,
|
|
});
|
|
return inline ? md.renderInline(item) : md.render(item);
|
|
},
|
|
},
|
|
computed: {
|
|
demoUrl: function () {
|
|
return 'https://rsshub.app'+ this.example
|
|
}
|
|
}
|
|
}
|
|
</script>
|