feat: Generate documentation using typedoc

.gitattributes

@@ -0,0 +1,2 @@
+# REF: https://docs.github.com/zh/get-started/getting-started-with-git/configuring-git-to-handle-line-endings
+* text eol=lf

.gitignore

@@ -1 +1,3 @@
 .idea/
+node_modules/
+docs/html/

.husky/pre-commit

@@ -0,0 +1,8 @@
+pnpm run docs:build
+pnpm run docs:format
+
+pnpm run format
+
+git add ./docs
+
+exit 0

CHANGELOG.md

@@ -1,6 +1,12 @@
+<!-- cSpell:ignore positon -->
+
 # Changelog
 
-## v1.0.3 2024-06
+- Add `eslint` formatting configuration
+- Add `cSpell` spelling check configuration
+- Add `typedoc` documentation generation configuration
+- Add documentation
+- Adjust `typedoc-plugin-markdown` configuration
 
 ## v1.0.2 2024-06-04
 
@@ -70,7 +76,7 @@
 ## 0.8.7 2023-10-24
 
 * [Deprecated `loaded-protyle` use `loaded-protyle-static` instead](https://github.com/siyuan-note/siyuan/issues/9468)
-* [Fix event defail for `loaded-protyle`](https://github.com/siyuan-note/petal/pull/18)
+* [Fix event defined for `loaded-protyle`](https://github.com/siyuan-note/petal/pull/18)
 * [Add plugin event bus `paste`](https://github.com/siyuan-note/siyuan/issues/9452)
 
 ## 0.8.6 2023-10-17

README.md

@@ -1,3 +1,13 @@
 # SiYuan Plugin API
 
-Here is the API declaration of SiYuan Plugin System, usages please refer to  [SiYuan plugin sample](https://github.com/siyuan-note/plugin-sample).
+Here is the Plugin API declaration of [SiYuan](https://github.com/siyuan-note/siyuan), usages please refer to [SiYuan plugin sample](https://github.com/siyuan-note/plugin-sample).
+
+## Installation
+
+```shell
+> npm install siyuan --save-dev
+```
+
+## Documentation
+
+Please visit the [petal/docs/markdown at main · siyuan-note/petal](https://github.com/siyuan-note/petal/tree/main/docs/markdown) for comprehensive documentation.

cspell.config.yaml

@@ -0,0 +1,60 @@
+$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-types/cspell.schema.json
+version: "0.2"
+ignorePaths:
+  - ./package.json
+  - ./pnpm-lock.yaml
+dictionaryDefinitions: []
+dictionaries: []
+words:
+  - AIAPI
+  - antfu
+  - backlink
+  - backlinks
+  - backmention
+  - blockicon
+  - blockref
+  - breadcrumbmore
+  - codelang
+  - dailynoteid
+  - docinfo
+  - doctree
+  - dprint
+  - editorcontent
+  - editortitleicon
+  - exportimg
+  - exportpdf
+  - exportword
+  - fileannotationref
+  - filetree
+  - focusfirst
+  - fontstyles
+  - FSRS
+  - fullwidth
+  - historynoteid
+  - IAPI
+  - katex
+  - Keymap
+  - Mindmap
+  - newwindow
+  - nolist
+  - noneditableblock
+  - Pandoc
+  - pdftheme
+  - plugintopunpin
+  - protyle
+  - rootscroll
+  - searchasset
+  - searchdata
+  - searchkeys
+  - Setext
+  - setid
+  - siyuan
+  - unchangeid
+  - unreviewed
+  - unundo
+  - webdav
+  - wechat
+ignoreWords: []
+ignoreRegExpList:
+  - \d{14}-[0-9a-z]{7}
+import: []

docs/markdown/README.md

@@ -0,0 +1,93 @@
+**SiYuan Plugin API v1.0.2** • **Docs**
+
+---
+
+# SiYuan Plugin API v1.0.2
+
+## Namespaces
+
+| Namespace                             | Description |
+| ------------------------------------- | ----------- |
+| [Config](namespaces/Config/README.md) | -           |
+
+## Classes
+
+| Class                             | Description                                             |
+| --------------------------------- | ------------------------------------------------------- |
+| [App](classes/App.md)             | The context of the SiYuan plugin <br/> 思源插件的上下文 |
+| [Constants](classes/Constants.md) | -                                                       |
+| [Dialog](classes/Dialog.md)       | -                                                       |
+| [EventBus](classes/EventBus.md)   | -                                                       |
+| [EventMenu](classes/EventMenu.md) | -                                                       |
+| [Lute](classes/Lute.md)           | -                                                       |
+| [Menu](classes/Menu.md)           | -                                                       |
+| [Plugin](classes/Plugin.md)       | -                                                       |
+| [Protyle](classes/Protyle.md)     | -                                                       |
+| [Setting](classes/Setting.md)     | -                                                       |
+| [Toolbar](classes/Toolbar.md)     | -                                                       |
+
+## Interfaces
+
+| Interface                                        | Description |
+| ------------------------------------------------ | ----------- |
+| [Global](interfaces/Global.md)                   | -           |
+| [I18N](interfaces/I18N.md)                       | -           |
+| [ICard](interfaces/ICard.md)                     | -           |
+| [ICardData](interfaces/ICardData.md)             | -           |
+| [ICommandOption](interfaces/ICommandOption.md)   | -           |
+| [ICustomModel](interfaces/ICustomModel.md)       | -           |
+| [IDockModel](interfaces/IDockModel.md)           | -           |
+| [IEventBusMap](interfaces/IEventBusMap.md)       | -           |
+| [IGetDocInfo](interfaces/IGetDocInfo.md)         | -           |
+| [IGetTreeStat](interfaces/IGetTreeStat.md)       | -           |
+| [IKeymap](interfaces/IKeymap.md)                 | -           |
+| [IKeymapItem](interfaces/IKeymapItem.md)         | -           |
+| [ILuteNode](interfaces/ILuteNode.md)             | -           |
+| [IMenuBaseDetail](interfaces/IMenuBaseDetail.md) | -           |
+| [IMenuItemOption](interfaces/IMenuItemOption.md) | -           |
+| [IModel](interfaces/IModel.md)                   | -           |
+| [IObject](interfaces/IObject.md)                 | -           |
+| [IOperation](interfaces/IOperation.md)           | -           |
+| [IPluginDockTab](interfaces/IPluginDockTab.md)   | -           |
+| [IPosition](interfaces/IPosition.md)             | -           |
+| [IProtyle](interfaces/IProtyle.md)               | -           |
+| [IProtyleOption](interfaces/IProtyleOption.md)   | -           |
+| [ISearchOption](interfaces/ISearchOption.md)     | -           |
+| [ISiyuan](interfaces/ISiyuan.md)                 | -           |
+| [ITab](interfaces/ITab.md)                       | -           |
+| [ITabModel](interfaces/ITabModel.md)             | -           |
+| [IToolbarItem](interfaces/IToolbarItem.md)       | -           |
+| [IWebSocketData](interfaces/IWebSocketData.md)   | -           |
+
+## Type Aliases
+
+| Type alias                                         | Description |
+| -------------------------------------------------- | ----------- |
+| [TAVCol](type-aliases/TAVCol.md)                   | -           |
+| [TBackendEnv](type-aliases/TBackendEnv.md)         | -           |
+| [TCardType](type-aliases/TCardType.md)             | -           |
+| [TEditorMode](type-aliases/TEditorMode.md)         | -           |
+| [TEventBus](type-aliases/TEventBus.md)             | -           |
+| [TFrontendEnv](type-aliases/TFrontendEnv.md)       | -           |
+| [TOperation](type-aliases/TOperation.md)           | -           |
+| [TProtyleAction](type-aliases/TProtyleAction.md)   | -           |
+| [TTurnInto](type-aliases/TTurnInto.md)             | -           |
+| [TTurnIntoOne](type-aliases/TTurnIntoOne.md)       | -           |
+| [TTurnIntoOneSub](type-aliases/TTurnIntoOneSub.md) | -           |
+
+## Functions
+
+| Function                                              | Description |
+| ----------------------------------------------------- | ----------- |
+| [adaptHotkey](functions/adaptHotkey.md)               | -           |
+| [confirm](functions/confirm.md)                       | -           |
+| [fetchGet](functions/fetchGet.md)                     | -           |
+| [fetchPost](functions/fetchPost.md)                   | -           |
+| [fetchSyncPost](functions/fetchSyncPost.md)           | -           |
+| [getBackend](functions/getBackend.md)                 | -           |
+| [getFrontend](functions/getFrontend.md)               | -           |
+| [lockScreen](functions/lockScreen.md)                 | -           |
+| [openMobileFileById](functions/openMobileFileById.md) | -           |
+| [openTab](functions/openTab.md)                       | -           |
+| [openWindow](functions/openWindow.md)                 | -           |
+| [showMessage](functions/showMessage.md)               | -           |

docs/markdown/classes/App.md

@@ -0,0 +1,41 @@
+[**SiYuan Plugin API v1.0.2**](../README.md) • **Docs**
+
+---
+
+[SiYuan Plugin API v1.0.2](../README.md) / App
+
+# Class: App
+
+The context of the SiYuan plugin
+<br/>
+思源插件的上下文
+
+## Constructors
+
+### new App()
+
+> **new App**(): [`App`](App.md)
+
+#### Returns
+
+[`App`](App.md)
+
+## Properties
+
+### appId
+
+> **appId**: `string`
+
+#### Defined in
+
+[siyuan.d.ts:536](https://github.com/siyuan-note/petal/tree/main/siyuan.d.ts#L536)
+
+---
+
+### plugins
+
+> **plugins**: [`Plugin`](Plugin.md)[]
+
+#### Defined in
+
+[siyuan.d.ts:535](https://github.com/siyuan-note/petal/tree/main/siyuan.d.ts#L535)