LeonardandEvan Simkowitz
94f76946fc
* Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
30 lines
742 B
Markdown
30 lines
742 B
Markdown
# Dirs Functions
|
|
|
|
Dirs functions are for getting various directory paths. Not to be confused with `plugin.path`.
|
|
|
|
### `plugin_dir() -> string`
|
|
|
|
Get the plugin's root directory path.
|
|
|
|
```lua
|
|
local path = plugin.dirs.plugin_dir()
|
|
-- example: ~/Development/DioxusCli/plugin/test-plugin/
|
|
```
|
|
|
|
### `bin_dir() -> string`
|
|
|
|
Get the plugin's binary directory path. Put binary files like `tailwind-cli` or `sass-cli` in this directory.
|
|
|
|
```lua
|
|
local path = plugin.dirs.bin_dir()
|
|
-- example: ~/Development/DioxusCli/plugin/test-plugin/bin/
|
|
```
|
|
|
|
### `temp_dir() -> string`
|
|
|
|
Get the plugin's temporary directory path. Put any temporary files here.
|
|
|
|
```lua
|
|
local path = plugin.dirs.bin_dir()
|
|
-- example: ~/Development/DioxusCli/plugin/test-plugin/temp/
|
|
``` |