Skip to content

Broken parameter links when parametersFormat is set to table or htmlTable #870

Description

@Legend-Master

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

This is similar to #463

Input

/**
 * Opens a url with the system's default app, or the one specified with {@linkcode openWith}.
 *
 * @example
 * ```typescript
 * import { openUrl } from '@tauri-apps/plugin-opener';
 *
 * // opens the given URL on the default browser:
 * await openUrl('https://github.com/tauri-apps/tauri');
 * // opens the given URL using `firefox`:
 * await openUrl('https://github.com/tauri-apps/tauri', 'firefox');
 * ```
 *
 * @param url The URL to open.
 * @param openWith The app to open the URL with. If not specified, defaults to the system default application for the specified url type.
 * On mobile, `openWith` can be provided as `inAppBrowser` to open the URL in an in-app browser. Otherwise, it will open the URL in the system default browser.
 *
 * @since 2.0.0
 */
export async function openUrl(
  url: string | URL,
  // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
  openWith?: 'inAppBrowser' | string
): Promise {
  await invoke('plugin:opener|open_url', {
    url,
    with: openWith
  })
}

Output



### openPath()

```ts
function openPath(path, openWith?): Promise;
```

**Source**: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/opener/guest-js/index.ts#L71

Opens a path with the system's default app, or the one specified with [`openWith`](/reference/javascript/opener/#openpath-2).

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `path` | `string` | The path to open. |
| `openWith?` | `string` | The app to open the path with. If not specified, defaults to the system default application for the specified path type. |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

#### Example

```typescript
import { openPath } from '@tauri-apps/plugin-opener';

// opens a file using the default program:
await openPath('/path/to/file');
// opens a file using `vlc` command on Windows.
await openPath('C:/path/to/file', 'vlc');
```

#### Since

2.0.0

***

TypeDoc configuration

{
  // TypeDoc options
  // https://typedoc.org/options/
  githubPages: false,
  hideGenerator: true,
  theme: 'tauri-theme',
  plugin: ['typedoc-plugin-mdn-links', 'typedoc-plugin-markdown'],
  readme: 'none',
  logLevel: 'Warn',
  // typedoc-plugin-markdown options
  // https://github.com/tgreyuk/typedoc-plugin-markdown/blob/next/packages/typedoc-plugin-markdown/docs/usage/options.md
  outputFileStrategy: 'modules',
  flattenOutputFiles: true,
  entryFileName: 'index.md',
  hidePageHeader: true,
  hidePageTitle: true,
  hideBreadcrumbs: true,
  useCodeBlocks: true,
  parametersFormat: 'table',
  propertiesFormat: 'table',
  typeDeclarationFormat: 'table',
  useHTMLAnchors: true,
}

tauri-apps/tauri-docs#3910

Expected behavior

Either don't generate the link, or make the link work

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugIssue raised as a bug.

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions