From ecdacdd09f0a095b98d483d4a2f73821f8cb390c Mon Sep 17 00:00:00 2001 From: UZQueen <157540577+HanaokaYuzu@users.noreply.github.com> Date: Mon, 3 Feb 2025 12:32:00 -0600 Subject: [PATCH] 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 * 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 --------- --- lib/routes/misskey/home-timeline.ts | 30 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/lib/routes/misskey/home-timeline.ts b/lib/routes/misskey/home-timeline.ts index 8e1ac5dc708596..4e389492bdd7d4 100644 --- a/lib/routes/misskey/home-timeline.ts +++ b/lib/routes/misskey/home-timeline.ts @@ -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) {