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

docs(routes/misskey): fix documentation formatting for misskey home timeline (#18271) 

* feat(route): add misskey home timeline

* Update lib/routes/misskey/home-timeline.ts

Co-authored-by: Tony <TonyRL@users.noreply.github.com>

* Merge remote-tracking branch 'head/master'

* feat(route/misskey): Enhance user timeline with simplifyAuthor parameter and update replyToAuthor in utils

* docs(routes/misskey): fix documentation formatting for misskey home timeline

---------
This commit is contained in:
UZQueen 2025-02-03 12:32:00 -06:00 committed by GitHub
parent 72f78e2bfb
commit ecdacdd09f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
lib/routes/misskey/home-timeline.ts
View File

@ -14,19 +14,19 @@ export const route: Route = {
parameters: {
site: 'instance address, domain only, without `http://` or `https://` protocol header',
routeParams: `
| Key | Description | Accepted Values | Default |
| -------------------- | --------------------------------------- | --------------- | ------- |
| limit | Number of notes to return | integer | 10 |
| withFiles | Only return notes containing files | 0/1/true/false | false |
| withRenotes | Include renotes in the timeline | 0/1/true/false | true |
| allowPartial | Allow partial results | 0/1/true/false | true |
| simplifyAuthor | Simplify author field in feed items | 0/1/true/false | true |
| Key | Description | Accepted Values | Default |
| -------------------- | --------------------------------------- | --------------- | ------- |
| limit | Number of notes to return | integer | 10 |
| withFiles | Only return notes containing files | 0/1/true/false | false |
| withRenotes | Include renotes in the timeline | 0/1/true/false | true |
| allowPartial | Allow partial results | 0/1/true/false | true |
| simplifyAuthor | Simplify author field in feed items | 0/1/true/false | true |
Note: If \`withFiles\` is set to true, renotes will not be included in the timeline regardless of the value of \`withRenotes\`.
Note: If \`withFiles\` is set to true, renotes will not be included in the timeline regardless of the value of \`withRenotes\`.
Examples:
- /misskey/timeline/home/misskey.io/limit=20&withFiles=true
- /misskey/timeline/home/misskey.io/withRenotes=false
Examples:
- /misskey/timeline/home/misskey.io/limit=20&withFiles=true
- /misskey/timeline/home/misskey.io/withRenotes=false
`,
},
features: {
@ -55,11 +55,9 @@ export const route: Route = {
name: 'Home Timeline',
maintainers: ['HanaokaYuzu'],
handler,
description: `
::: warning
This route is only available for self-hosted instances.
:::
`,
description: `::: warning
This route is only available for self-hosted instances.
:::`,
};
async function handler(ctx) {