docs: commit new document
This commit is contained in:
1 parent
f099042726
commit
d47319526c
3 files changed
+48
No files matched your search
@@ -11,3 +11,5 @@
|
|||||||
- [Translate](./cmd/translate.md)
|
- [Translate](./cmd/translate.md)
|
||||||
- [Plugin Development](./plugin/README.md)
|
- [Plugin Development](./plugin/README.md)
|
||||||
- [API.Command](./plugin/interface/command.md)
|
- [API.Command](./plugin/interface/command.md)
|
||||||
|
- [API.OS](./plugin/interface/os.md)
|
||||||
|
- [API.Directories](./plugin/interface/dirs.md)
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# Dirs Functions
|
||||||
|
|
||||||
|
> you can use Dirs functions to get some directory path
|
||||||
|
|
||||||
|
|
||||||
|
### plugin_dir() -> string
|
||||||
|
|
||||||
|
You can get current plugin **root** directory path
|
||||||
|
|
||||||
|
```lua
|
||||||
|
local path = plugin.dirs.plugin_dir()
|
||||||
|
-- example: ~/Development/DioxusCli/plugin/test-plugin/
|
||||||
|
```
|
||||||
|
|
||||||
|
### bin_dir() -> string
|
||||||
|
|
||||||
|
You can get plugin **bin** direcotry path
|
||||||
|
|
||||||
|
Sometime you need install some binary file like `tailwind-cli` & `sass-cli` to help your plugin work, then you should put binary file in this directory.
|
||||||
|
|
||||||
|
```lua
|
||||||
|
local path = plugin.dirs.bin_dir()
|
||||||
|
-- example: ~/Development/DioxusCli/plugin/test-plugin/bin/
|
||||||
|
```
|
||||||
|
|
||||||
|
### temp_dir() -> string
|
||||||
|
|
||||||
|
You can get plugin **temp** direcotry path
|
||||||
|
|
||||||
|
Just put some temporary file in this directory.
|
||||||
|
|
||||||
|
```lua
|
||||||
|
local path = plugin.dirs.bin_dir()
|
||||||
|
-- example: ~/Development/DioxusCli/plugin/test-plugin/temp/
|
||||||
|
```
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# OS Functions
|
||||||
|
|
||||||
|
> you can use OS functions to get some system information
|
||||||
|
|
||||||
|
### current_platform() -> string ("windows" | "macos" | "linux")
|
||||||
|
|
||||||
|
This function can help you get system & platform type:
|
||||||
|
|
||||||
|
```lua
|
||||||
|
local platform = plugin.os.current_platform()
|
||||||
|
```
|
||||||
Reference in new issue
Block a user