Skip to content

Commit 3591447

Browse files
HenryQWDIYgod
authored andcommitted
Revamp the doc. Add LICENSE file. (DIYgod#580)
1. 参数现在和英文版一样使用 list 2. 全角`,`, `:`改半角`,`, `:` 3. 补全部分遗漏 4. 修改部分格式
1 parent 2ac0830 commit 3591447

File tree

5 files changed

+109
-88
lines changed

5 files changed

+109
-88
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 DIYgod
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

docs/en/joinus/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ We welcome all pull requests. Suggestions and feedback are also welcomed [here](
2020

2121
### Access the target data source API
2222

23-
Use [axios](https://github.com/axios/axios) to access the target data source API, assign the acquired title, link, description and datetime to ctx.state.datarefer to Data for the list of parameters, typically it looks like this: [/routes/bilibili/bangumi.js](https://github.com/DIYgod/RSSHub/blob/master/routes/bilibili/bangumi.js)
23+
Use [axios](https://github.com/axios/axios) to access the target data source API, assign the acquired title, link, description and datetime to ctx.state.data (refer to Data for the list of parameters) , typically it looks like this: [/routes/bilibili/bangumi.js](https://github.com/DIYgod/RSSHub/blob/master/routes/bilibili/bangumi.js)
2424

2525
### Acquire data from HTML
2626

@@ -72,17 +72,17 @@ Reference article:
7272

7373
- [Create a podcast - Apple](https://help.apple.com/itc/podcasts_connect/?lang=en#/itca5b22233a)
7474
- [Podcast best practices - Apple](https://help.apple.com/itc/podcasts_connect/?lang=en#/itc2b3780e76)
75-
- Itunes podcast XML generator https://codepen.io/jon-walstedt/pen/jsIup
76-
- Feed Validation Service https://podba.se/validate/?url=https://rsshub.app/ximalaya/album/299146/
75+
- Itunes podcast XML generator : https://codepen.io/jon-walstedt/pen/jsIup
76+
- Feed Validation Service : https://podba.se/validate/?url=https://rsshub.app/ximalaya/album/299146/
7777

78-
these datas can make your podcast subscribeable
78+
these datas can make your podcast subscribeable:
7979

8080
```js
8181
ctx.state.data = {
8282
title: '', // The feed title
8383
link: '', // The feed link
8484
itunes_author: '', // The channel's author, you must fill this data.
85-
itunes_category '',// Channel category
85+
itunes_category: '',// Channel category
8686
image: '', // Channel's image
8787
description: '', // The feed description
8888
item: [

0 commit comments

Comments
 (0)