Skip to content

Commit aaba05c

Browse files
tjextjex
committed
fix: docs table indentation
1 parent c946124 commit aaba05c

File tree

1 file changed

+35
-30
lines changed

1 file changed

+35
-30
lines changed

‎docs/tips/editors-integration.md

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -231,36 +231,41 @@ This LSP command calls `zk list` to search a notebook. It takes two arguments:
231231
1. A path to any file or directory in the notebook, to locate it.
232232
2. <details><summary>A dictionary of additional options (click to expand)</summary>
233233

234-
| Key | Type | Required? | Description |
235-
| ---------------- | ------------ | --------- | --------------------------------------------------------------------------------------------------------- |
236-
| `select` | string array | Yes | List of note fields to return<sup>1</sup> |
237-
| `hrefs` | string array | No | Find notes matching the given path, including its descendants |
238-
| `limit` | integer | No | Limit the number of notes found |
239-
| `match` | string array | No | Terms to search for in the notes |
240-
| `exactMatch` | boolean | No | (deprecated: use `matchStrategy`) Search for exact occurrences of the `match` argument (case insensitive) |
241-
| `matchStrategy` | string | No | Specify match strategy, which may be "fts" (default), "exact" or "re" |
242-
| `excludeHrefs` | string array | No | Ignore notes matching the given path, including its descendants |
243-
| `tags` | string array | No | Find notes tagged with the given tags |
244-
| `mention` | string array | No | Find notes mentioning the title of the given ones |
245-
| `mentionedBy` | string array | No | Find notes whose title is mentioned in the given ones |
246-
| `linkTo` | string array | No | Find notes which are linking to the given ones |
247-
| `linkedBy` | string array | No | Find notes which are linked by the given ones |
248-
| `orphan` | boolean | No | Find notes which are not linked by any other note |
249-
| `tagless` | boolean | No | Find notes which have no tags |
250-
| `related` | string array | No | Find notes which might be related to the given ones |
251-
| `maxDistance` | integer | No | Maximum distance between two linked notes |
252-
| `recursive` | boolean | No | Follow links recursively |
253-
| `created` | string | No | Find notes created on the given date |
254-
| `createdBefore` | string | No | Find notes created before the given date |
255-
| `createdAfter` | string | No | Find notes created after the given date |
256-
| `modified` | string | No | Find notes modified on the given date |
257-
| `modifiedBefore` | string | No | Find notes modified before the given date |
258-
| `modifiedAfter` | string | No | Find notes modified after the given date |
259-
| `sort` | string array | No | Order the notes by the given criterion |
260-
261-
1. As the output of this command might be very verbose and put a heavy load on the LSP client, you need to explicitly set which note fields you want to receive with the `select` option. The following fields are available: `filename`, `filenameStem`, `path`, `absPath`, `title`, `lead`, `body`, `snippets`, `rawContent`, `wordCount`, `tags`, `metadata`, `created`, `modified` and `checksum`.
262-
263-
</details>
234+
| Key | Type | Required? | Description |
235+
| ---------------- | ------------ | --------- | --------------------------------------------------------------------------------------------------------- |
236+
| `select` | string array | Yes | List of note fields to return<sup>1</sup> |
237+
| `hrefs` | string array | No | Find notes matching the given path, including its descendants |
238+
| `limit` | integer | No | Limit the number of notes found |
239+
| `match` | string array | No | Terms to search for in the notes |
240+
| `exactMatch` | boolean | No | (deprecated: use `matchStrategy`) Search for exact occurrences of the `match` argument (case insensitive) |
241+
| `matchStrategy` | string | No | Specify match strategy, which may be "fts" (default), "exact" or "re" |
242+
| `excludeHrefs` | string array | No | Ignore notes matching the given path, including its descendants |
243+
| `tags` | string array | No | Find notes tagged with the given tags |
244+
| `mention` | string array | No | Find notes mentioning the title of the given ones |
245+
| `mentionedBy` | string array | No | Find notes whose title is mentioned in the given ones |
246+
| `linkTo` | string array | No | Find notes which are linking to the given ones |
247+
| `linkedBy` | string array | No | Find notes which are linked by the given ones |
248+
| `orphan` | boolean | No | Find notes which are not linked by any other note |
249+
| `tagless` | boolean | No | Find notes which have no tags |
250+
| `related` | string array | No | Find notes which might be related to the given ones |
251+
| `maxDistance` | integer | No | Maximum distance between two linked notes |
252+
| `recursive` | boolean | No | Follow links recursively |
253+
| `created` | string | No | Find notes created on the given date |
254+
| `createdBefore` | string | No | Find notes created before the given date |
255+
| `createdAfter` | string | No | Find notes created after the given date |
256+
| `modified` | string | No | Find notes modified on the given date |
257+
| `modifiedBefore` | string | No | Find notes modified before the given date |
258+
| `modifiedAfter` | string | No | Find notes modified after the given date |
259+
| `sort` | string array | No | Order the notes by the given criterion |
260+
261+
1. As the output of this command might be very verbose and put a heavy load on
262+
the LSP client, you need to explicitly set which note fields you want to
263+
receive with the `select` option. The following fields are available:
264+
`filename`, `filenameStem`, `path`, `absPath`, `title`, `lead`, `body`,
265+
`snippets`, `rawContent`, `wordCount`, `tags`, `metadata`, `created`,
266+
`modified` and `checksum`.
267+
268+
</details>
264269

265270
`zk.list` returns the found notes as a JSON array.
266271

0 commit comments

Comments
 (0)