docs: Use @linkcode and other markdown decoration syntaxes

Author: takker99

browser/dom/cache.ts

@@ -3,8 +3,10 @@
  * This function searches through the cache storage in reverse chronological order
  * to find the most recent cached response for a given request.
  *
- * > [!Note]
+ * > [!NOTE]
  * > Implementation inspired by Scrapbox's ServiceWorker and Cache usage pattern.
+ * > {@see https://scrapbox.io/daiiz/ScrapboxでのServiceWorkerとCacheの活用#5d2efaffadf4e70000651173}
+
  *
  * @param request The request to find a cached response for
  * @param options Cache query options (e.g., to ignore search params)
@@ -48,7 +50,7 @@ export const generateCacheName = (date: Date): string =>
  * 1. `"prefetch"` cache - temporary storage, cleared after first use
  * 2. `"api-yyyy-MM-dd"` cache - date-based persistent storage
  *
- * > [!Note]
+ * > [!NOTE]
  * > Throws an exception if the network connection is slow
  *
  * @param urls List of API URLs to prefetch

browser/dom/cursor.d.ts

@@ -11,7 +11,7 @@ export interface SetPositionOptions {
 
   /** Source of the cursor movement event
    *
-   * "mouse" indicates the cursor was moved by mouse interaction
+   * `"mouse"` indicates the cursor was moved by mouse interaction
    */
   source?: "mouse";
 }

browser/dom/extractCodeFiles.ts

@@ -28,7 +28,7 @@ export interface CodeBlock {
 
   /** Lines of code within the block
    *
-   * Excludes .code-title
+   * Excludes `.code-title`
    *
    * Indentation is already removed from each line
    */
@@ -54,7 +54,7 @@ export const extractCodeFiles = (
         startId: line.id,
         endId: line.id,
         updated: line.updated,
-        // Register the indentation level of .code-title, not the content
+        // Register the indentation level of `.code-title`, not the content
         indent: rest.indent - 1,
         lines: [],
       });

browser/dom/getCachedLines.ts

@@ -10,13 +10,13 @@ let initialize: (() => void) | undefined = () => {
   initialize = undefined;
 };
 
-/** Get cached version of scrapbox.Page.lines
+/** Get cached version of `{@linkcode https://jsr.io/@cosense/types/doc/userscript/~/Page.lines scrapbox.Page.lines}`
  *
- * This function caches the result of scrapbox.Page.lines to improve performance,
+ * This function caches the result of `{@linkcode https://jsr.io/@cosense/types/doc/userscript/~/Page.lines scrapbox.Page.lines}` to improve performance,
  * as generating the lines array is computationally expensive.
  * The cache is automatically invalidated when the page content changes.
  *
- * @return Same as `scrapbox.Page.lines`. Always returns the latest data through cache management
+ * @returns Same as `{@linkcode https://jsr.io/@cosense/types/doc/userscript/~/Page.lines scrapbox.Page.lines}`. Always returns the latest data through cache management
  */
 export const getCachedLines = (): readonly Line[] | null => {
   initialize?.();

browser/dom/node.ts

@@ -110,7 +110,7 @@ export const getText = <T extends HTMLElement>(
   if (value.classList.contains("char-index")) {
     return value.textContent ?? undefined;
   }
-  // When the element contains div.lines (which contains multiple div.line elements), return all text content concatenated
+  // When the element contains `div.lines` (which contains multiple div.line elements), return all text content concatenated
   if (
     value.classList.contains("line") ||
     value.getElementsByClassName("lines")?.[0]

browser/dom/open.ts

@@ -14,14 +14,16 @@ export interface OpenOptions {
   body?: string;
 
   /** Whether to open the page in a new tab
+   * - `true`: open in a new tab
+   * - `false`: open in the same tab
    *
-   * @default false (opens in the same tab)
+   * @default {false}
    */
   newTab?: boolean;
 
   /** Whether to reload the page when opening in the same tab
    *
-   * @default false for same project (no reload), true for different project (force reload)
+   * Default value is `false` for same project (no reload) and `true` for different project (force reload)
    */
   reload?: boolean;
 

browser/dom/page.d.ts

@@ -3,15 +3,15 @@ import type { Page as PageData } from "@cosense/types/rest";
 
 export interface SetPositionOptions {
   /** Whether to auto-scroll the page when the cursor moves outside the viewport
-   * When true, the page will automatically scroll to keep the cursor visible
+   * When `true`, the page will automatically scroll to keep the cursor visible
    *
-   * @default true
+   * @default {true}
    */
   scrollInView?: boolean;
 
   /** Source of the cursor movement event
    *
-   * Can be set to "mouse" when the cursor movement is triggered by mouse interaction
+   * Can be set to `"mouse"` when the cursor movement is triggered by mouse interaction
    * This parameter helps distinguish between different types of cursor movements
    */
   source?: "mouse";
@@ -35,7 +35,8 @@ export type PageWithCache = PageData & { cachedAt: number | undefined };
 
 /** Internal class for managing Scrapbox page data
  *
- * Note: Some type definitions are still in progress and may be incomplete
+ * > [!NOTE]
+ * > Some type definitions are still in progress and may be incomplete
  */
 export declare class Page extends BaseStore<
   { source: "mouse" | undefined } | "focusTextInput" | "scroll" | undefined

browser/dom/press.ts

@@ -12,7 +12,8 @@ export interface PressOptions {
 /** Dispatches a keyboard event programmatically via JavaScript
  *
  * Used to send keyboard input commands to Scrapbox.
- * Note: This function appears to block synchronously until Scrapbox's event listeners
+ * > [!NOTE]
+ * > This function appears to block synchronously until Scrapbox's event listeners
  * finish processing the keyboard event.
  *
  * @param key The name of the key to simulate pressing

browser/dom/stores.ts

@@ -8,8 +8,8 @@ export type { Cursor, Selection };
  * This function accesses React's internal fiber tree to obtain references to
  * the Cursor and Selection store instances that Scrapbox uses to manage
  * text input state. These stores provide APIs for:
- * - Cursor: Managing text cursor position and movement
- * - Selection: Handling text selection ranges and operations
+ * - {@linkcode Cursor}: Managing text cursor position and movement
+ * - {@linkcode Selection}: Handling text selection ranges and operations
  *
  * @throws {Error} If text input element or stores cannot be found
  * @returns Object containing cursor and selection store instances

browser/dom/takeInternalLines.ts

@@ -4,16 +4,16 @@ import type { BaseLine } from "@cosense/types/userscript";
 /** Get a reference to Scrapbox's internal page content data
  *
  * This function provides direct access to the page content without deep cloning,
- * unlike `scrapbox.Page.lines` which creates a deep copy. Use this when:
+ * unlike `{@linkcode https://jsr.io/@cosense/types/doc/userscript/~/Page.lines scrapbox.Page.lines}` which creates a deep copy. Use this when:
  * - You need better performance by avoiding data cloning
  * - You only need to read the raw line data
  *
- * Important Notes:
- * - This returns a direct reference to the internal data. While the type definition
- *   marks it as readonly, the content can still be modified through JavaScript.
- *   Be careful not to modify the data to avoid unexpected behavior.
- * - Unlike `scrapbox.Page.lines`, the returned data does not include parsed
- *   syntax information (no syntax tree or parsed line components).
+ * > [!IMPORTANT]
+ * > - This returns a direct reference to the internal data. While the type definition
+ * >   marks it as readonly, the content can still be modified through JavaScript.
+ * >   Be careful not to modify the data to avoid unexpected behavior.
+ * > - Unlike `{@linkcode https://jsr.io/@cosense/types/doc/userscript/~/Page.lines scrapbox.Page.lines}`, the returned data does not include parsed
+ * >   syntax information (no syntax tree or parsed line components).
  *
  * @returns A readonly array of BaseLine objects representing the page content
  */