mirror of
https://github.com/DIYgod/RSSHub.git
synced 2025-12-14 17:19:37 +08:00
1de1e9ae56
* build: use pnpm * fix: use corepack pnpm * chore: use pnpm in gha * chore: add setup pnpm * fix: install command * fix: pnpm lock file not updated * chore: pnpm no recursive install * docs: use pnpm * fix: ignore yarn lock * chore: update command for cloud dev env
76 lines
1.9 KiB
Markdown
76 lines
1.9 KiB
Markdown
# Getting Started
|
|
|
|
## Generate an RSS Feed
|
|
|
|
To subscribe to a Twitter user's timeline, first look at the route document of [Twitter User Timeline](en/social-media.html#twitter-user-timeline).
|
|
|
|
`/twitter/user/:id` is the route where `:id` is the actual Twitter username you need to replace. For instance, `/twitter/user/DIYgod` with a prefix domain name will give you the timeline of Twitter user DIYgod.
|
|
|
|
The demo instance will generate an RSS feed at <https://rsshub.app/twitter/user/DIYgod>, use your own domain name when applicable. This feed should work with all RSS readers conforming to the RSS Standard.
|
|
|
|
You can replace the domain name `https://rsshub.app` with your [self-hosted instance](/en/install/).
|
|
|
|
RSSHub supports additional parameters such as content filtering and full-text extraction, refer to [Parameters](/en/parameter.html) for details.
|
|
|
|
## Contribute a New Route
|
|
|
|
Our thriving community is the key to RSSHub's success, we invite everyone to join us and [contribute new routes](/en/joinus/quick-start.html) for all kinds of interesting sources.
|
|
|
|
## Use as a npm Package
|
|
|
|
Apart from serving as an information source hub, RSSHub is also made compatible with all Node.js projects as an npm Package.
|
|
|
|
### Install
|
|
|
|
<code-group>
|
|
<code-block title="pnpm" active>
|
|
|
|
```bash
|
|
pnpm add rsshub
|
|
```
|
|
|
|
</code-block>
|
|
<code-block title="yarnv1">
|
|
|
|
```bash
|
|
yarn add rsshub
|
|
```
|
|
|
|
</code-block>
|
|
<code-block title="npm">
|
|
|
|
```bash
|
|
npm install rsshub --save
|
|
```
|
|
|
|
</code-block>
|
|
</code-group>
|
|
|
|
### Usage
|
|
|
|
```js
|
|
const RSSHub = require('rsshub');
|
|
|
|
RSSHub.init({
|
|
// config
|
|
});
|
|
|
|
RSSHub.request('/youtube/user/JFlaMusic')
|
|
.then((data) => {
|
|
console.log(data);
|
|
})
|
|
.catch((e) => {
|
|
console.log(e);
|
|
});
|
|
```
|
|
|
|
For supported configs please refer to the [Configuration Section](/en/install/#configuration-3).
|
|
|
|
A short example for disabling caching can be written as:
|
|
|
|
```js
|
|
{
|
|
CACHE_TYPE: null,
|
|
}
|
|
```
|