docs: quick start revamp (DIYgod#12198)

* docs: revamp quick start

* wip

* wip

* wip

* wip

* wip

* wip

* wip: radar

* wip: rich media

* wip: script standard

* wip: cache

* wip: chinese quick start

* wip: chinese quick start part 2

* wip: chinese quick start

* docs: add open collective

* retrigger ci

.devcontainer/devcontainer.json

@@ -17,6 +17,7 @@
                 "esbenp.prettier-vscode",
                 "deepscan.vscode-deepscan",
                 "rangav.vscode-thunder-client",
+                "SonarSource.sonarlint-vscode",
                 "ZihanLi.at-helper"
             ]
         }

.github/FUNDING.yml

@@ -1,4 +1,5 @@
 # These are supported funding model platforms
 github: DIYgod
+open_collective: RSSHub
 patreon: DIYgod
 custom: ['https://afdian.net/@diygod', 'https://diygod.me/images/zfb.jpg', 'https://diygod.me/images/wx.jpg']

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,13 @@
 <!-- 
-如有疑问，请参考 https://github.com/DIYgod/RSSHub/discussions/8002
-Reference: https://github.com/DIYgod/RSSHub/discussions/8002
+如有疑问，请参考 https://docs.rsshub.app/joinus/new-rss/submit-route.html
+Reference: https://docs.rsshub.app/en/joinus/new-rss/submit-route.html
 -->
 
-## 该 PR 相关 Issue / Involved issue
+## 该 PR 相关 Issue / Involved Issue
 
 Close #
 
-## 路由地址示例 / Example for the proposed route(s)
+## 路由地址示例 / Example for the Proposed Route(s)
 
 <!--
 请在 `routes` 区域填写以 / 开头的完整路由地址，否则你的 PR 将会被无条件关闭。
@@ -21,13 +21,13 @@ Please include route starts with /, with all required and optional parameters. F
 /use/the/fenced/code/block/below
 ```
 如果你的 PR 与路由无关, 请在 `routes` 区域 填写 `NOROUTE`，而不是直接删除 `routes` 区域。否则你的 PR 将会被无条件关闭。
-If your changes are not related to route, please fill in `routes` with `NOROUTE`. Fail to comply will result in your PR being closed.
+If your changes are not related to route, please fill in `routes` section with `NOROUTE`. Fail to comply will result in your PR being closed.
 -->
 
 ```routes
 ```
 
-## 新 RSS 检查列表 / New RSS Script Checklist
+## 新 RSS 路由检查表 / New RSS Route Checklist
 
 - [ ] 新的路由 New Route
   - [ ] 跟随 [v2 路由规范](https://docs.rsshub.app/joinus/script-standard.html) Follows [v2 Script Standard](https://docs.rsshub.app/en/joinus/script-standard.html)

.gitpod.yml

@@ -31,7 +31,7 @@ vscode:
     - esbenp.prettier-vscode
     - deepscan.vscode-deepscan
     - rangav.vscode-thunder-client
-    - TabNine.tabnine-vscode
+    - sonarsource.sonarlint-vscode
     # - ZihanLi.at-helper not available on Open VSX
 
 github:

.markdownlint.jsonc

@@ -0,0 +1,11 @@
+{
+    "MD007": { "indent": 4 }, // ul-indent - Unordered list indentation
+    "MD013": false, // line-length - Line length
+    "MD014": false, // commands-show-output - Dollar signs used before commands without showing output
+    "MD024": { "siblings_only": true }, // no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
+    "MD030": { "ul_single": 3, "ol_single": 2, "ul_multi": 3, "ol_multi": 2 }, // list-marker-space - Spaces after list markers
+    "MD033": false, // no-inline-html - Inline HTML
+    "MD036": false, // no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
+    "MD040": false, // fenced-code-language - Fenced code blocks should have a language specified
+    "MD051": false // link-fragments - Link fragments should be valid
+}

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-<img src="https://i.loli.net/2019/04/23/5cbeb7e41414c.png" alt="RSSHub" width="100">
+<img src="https://docs.rsshub.app/logo.png" alt="RSSHub" width="100">
 </p>
 <h1 align="center">RSSHub</h1>
 
@@ -87,6 +87,7 @@ You can support RSSHub via donations.
 Recurring donors will be rewarded via express issue response, or even have your name displayed on our GitHub page and website.
 
 -   Become a Sponser on [GitHub](https://github.com/sponsors/DIYgod)
+-   Become a Sponser on [Open Collective](https://opencollective.com/RSSHub)
 -   Become a Sponser on [Patreon](https://www.patreon.com/DIYgod)
 -   Become a Sponser on [爱发电](https://afdian.net/@diygod)
 -   Contact us directly: [email protected]

docs/.vuepress/config.js

@@ -46,6 +46,7 @@ module.exports = {
         anchor: {
             level: 999, // Disable original Plugin
         },
+        lineNumbers: true,
         extendMarkdown: (md) => {
             md.use(require('../.format/md/hierarchySlug'), {
                 slugify(s) {
@@ -83,6 +84,7 @@ module.exports = {
         editLinks: true,
         docsDir: 'docs',
         smoothScroll: true,
+        logo: '/logo.png',
         locales: {
             '/': {
                 lang: 'zh-CN',
@@ -92,6 +94,70 @@ module.exports = {
                 lastUpdated: '上次更新',
                 nav: require('./nav/zh'),
                 sidebar: {
+                    '/joinus/': [
+                        {
+                            title: '👥 参与我们',
+                            path: '/joinus/quick-start.html',
+                        },
+                        {
+                            title: '📰 提交新的 RSSHub 规则',
+                            path: '/joinus/new-rss/prerequisites.html',
+                            collapsable: false,
+                            children: [
+                                {
+                                    title: '🔑 准备工作',
+                                    path: 'new-rss/prerequisites',
+                                },
+                                {
+                                    title: '💡 开始之前',
+                                    path: 'new-rss/before-start',
+                                },
+                                {
+                                    title: '🚀 制作自己的 RSSHub 路由',
+                                    path: 'new-rss/start-code',
+                                },
+                                {
+                                    title: '📖 添加文档',
+                                    path: 'new-rss/add-docs',
+                                },
+                                {
+                                    title: '📤 提交路由',
+                                    path: 'new-rss/submit-route',
+                                },
+                            ],
+                        },
+                        {
+                            title: '📡 提交新的 RSSHub Radar 规则',
+                            path: '/joinus/new-radar.html',
+                        },
+                        {
+                            title: '💪 Advanced',
+                            path: '/joinus/advanced-feed.html',
+                            collapsable: false,
+                            children: [
+                                {
+                                    title: '🎧 制作多媒体 RSS 订阅源',
+                                    path: 'advanced-feed',
+                                },
+                                {
+                                    title: '📜 路由规范',
+                                    path: 'script-standard',
+                                },
+                                {
+                                    title: '💾 使用缓存',
+                                    path: 'use-cache',
+                                },
+                                {
+                                    title: '🗓️ 日期处理',
+                                    path: 'pub-date',
+                                },
+                                {
+                                    title: '🐛 调试',
+                                    path: 'debug',
+                                },
+                            ],
+                        },
+                    ],
                     '/': [
                         {
                             title: '指南',
@@ -139,6 +205,70 @@ module.exports = {
                 lastUpdated: 'Last Updated',
                 nav: require('./nav/en'),
                 sidebar: {
+                    '/en/joinus/': [
+                        {
+                            title: '👥 Join Us',
+                            path: '/en/joinus/quick-start.html',
+                        },
+                        {
+                            title: '📰 New RSSHub rules',
+                            path: '/en/joinus/new-rss/prerequisites.html',
+                            collapsable: false,
+                            children: [
+                                {
+                                    title: '🔑 Prerequisites',
+                                    path: 'new-rss/prerequisites',
+                                },
+                                {
+                                    title: '💡 Just before you start',
+                                    path: 'new-rss/before-start',
+                                },
+                                {
+                                    title: '🚀 Create your own RSSHub route',
+                                    path: 'new-rss/start-code',
+                                },
+                                {
+                                    title: '📖 Add documentation',
+                                    path: 'new-rss/add-docs',
+                                },
+                                {
+                                    title: '📤 Submit your route',
+                                    path: 'new-rss/submit-route',
+                                },
+                            ],
+                        },
+                        {
+                            title: '📡 New Radar Rules',
+                            path: '/en/joinus/new-radar.html',
+                        },
+                        {
+                            title: '💪 Advanced',
+                            path: '/en/joinus/advanced-feed.html',
+                            collapsable: false,
+                            children: [
+                                {
+                                    title: '🎧 Create a Rich Media RSS Feed',
+                                    path: 'advanced-feed',
+                                },
+                                {
+                                    title: '📜 Script Standard',
+                                    path: 'script-standard',
+                                },
+                                {
+                                    title: '💾 Caching',
+                                    path: 'use-cache',
+                                },
+                                {
+                                    title: '🗓️ Date Handling',
+                                    path: 'pub-date',
+                                },
+                                {
+                                    title: '🐛 Debugging',
+                                    path: 'debug',
+                                },
+                            ],
+                        },
+                    ],
                     '/en/': [
                         {
                             title: 'Guide',

docs/README.md

@@ -30,7 +30,7 @@ RSSHub 是一个开源、简单易用、易于扩展的 RSS 生成器，可以
 ### Special Sponsors
 
 <div style="margin: 30px 50px 20px 0;">
-<a href="https://rss3.io/" target="_blank"><img alt="RSS3" height="50px" src="https://i.imgur.com/vHtI4bz.png"></a>
+<a href="https://rss3.io" target="_blank"><img alt="RSS3" height="50px" src="https://i.imgur.com/vHtI4bz.png"></a>
 </div>
 
 [![](https://opencollective.com/static/images/become_sponsor.svg)](/support/)

docs/en/README.md

@@ -30,7 +30,7 @@ RSSHub can be used with browser extension [RSSHub Radar](https://github.com/DIYg
 ### Special Sponsors
 
 <div style="margin: 30px 50px 20px 0;">
-<a href="https://rss3.io/" target="_blank"><img alt="RSS3" height="50px" src="https://i.imgur.com/vHtI4bz.png"></a>
+<a href="https://rss3.io" target="_blank"><img alt="RSS3" height="50px" src="https://i.imgur.com/vHtI4bz.png"></a>
 </div>
 
 [![](https://opencollective.com/static/images/become_sponsor.svg)](/en/support/)

docs/en/api.md

@@ -20,7 +20,7 @@ Parameters:
 
 -   `name`, route's top level name as in [https://github.com/DIYgod/RSSHub/tree/master/lib/routes](https://github.com/DIYgod/RSSHub/tree/master/lib/routes). Optional, **returns all public routes if not specified**.
 
-A successful request returns a HTTP status code `200 OK` with the result in JSON:
+A successful request returns an HTTP status code `200 OK` with the result in JSON:
 
 ```js
 {
@@ -39,4 +39,4 @@ A successful request returns a HTTP status code `200 OK` with the result in JSON
 }
 ```
 
-If no matching results were found, the server returns only a HTTP status code `204 No Content`.
+If no matching results were found, the server returns only an HTTP status code `204 No Content`.

docs/en/blog.md

@@ -119,4 +119,3 @@ Limit the number of entries to be retrieved by adding `?limit=x` to the end of t
 ### Entry
 
 <RouteEn author="nczitzk" example="/yuzu-emu/entry" path="/yuzu-emu/entry" />
-

docs/en/game.md

@@ -269,9 +269,9 @@ For instance, in `https://store.steampowered.com/search/?specials=1&term=atelier
 
 Steam provides some official RSS feeds:
 
-- News home page: [https://store.steampowered.com/feeds/news/?l=english](https://store.steampowered.com/feeds/news/?l=english) the parameter `l=english` specifiy the language.
-- Game news rss can get from the rss buttom in page like this: [https://store.steampowered.com/news/app/648800/](https://store.steampowered.com/news/app/648800/), rss link will looks like： [https://store.steampowered.com/feeds/news/app/648800/?cc=US&l=english](https://store.steampowered.com/feeds/news/app/648800/?cc=US&l=english)
-- Steam group can add `/rss` behind Steam community URL to subscribe: [https://steamcommunity.com/groups/SteamLabs/rss](https://steamcommunity.com/groups/SteamLabs/rss) or add the `/feeds` in Steam News : [https://store.steampowered.com/feeds/news/group/35143931/](https://store.steampowered.com/feeds/news/group/35143931/)
+-   News home page: [https://store.steampowered.com/feeds/news/?l=english](https://store.steampowered.com/feeds/news/?l=english) the parameter `l=english` specifiy the language.
+-   Game news rss can get from the rss buttom in page like this: [https://store.steampowered.com/news/app/648800/](https://store.steampowered.com/news/app/648800/), rss link will looks like： [https://store.steampowered.com/feeds/news/app/648800/?cc=US&l=english](https://store.steampowered.com/feeds/news/app/648800/?cc=US&l=english)
+-   Steam group can add `/rss` behind Steam community URL to subscribe: [https://steamcommunity.com/groups/SteamLabs/rss](https://steamcommunity.com/groups/SteamLabs/rss) or add the `/feeds` in Steam News : [https://store.steampowered.com/feeds/news/group/35143931/](https://store.steampowered.com/feeds/news/group/35143931/)
 
 :::
 
@@ -333,7 +333,7 @@ Unlike TapTap China Mainland Website, the International Website has no BBS.
 
 <RouteEn author="axojhf" example="/warthunder/news" path="/warthunder/news">
 
-News data from https://warthunder.com/en/news/
+News data from <https://warthunder.com/en/news/>
 The year, month and day provided under UTC time zone are the same as the official website, so please ignore the specific time!!!
 
 </RouteEn>

docs/en/install/README.md

@@ -102,7 +102,7 @@ Execute the following command to pull RSSHub's docker image.
 $ docker pull diygod/rsshub
 ```
 
-Start a RSSHub container
+Start an RSSHub container
 
 ```bash
 $ docker run -d --name rsshub -p 1200:1200 diygod/rsshub