2022-03-14 11:11:12 +00:00
|
|
|
[application]
|
|
|
|
|
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
# App name
|
|
|
|
|
name = "project_name"
|
2022-03-14 11:11:12 +00:00
|
|
|
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
# The Dioxus platform to default to
|
|
|
|
|
default_platform = "web"
|
2022-03-14 11:11:12 +00:00
|
|
|
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
# `build` & `serve` output path
|
2022-03-14 11:11:12 +00:00
|
|
|
out_dir = "dist"
|
|
|
|
|
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
# The static resource path
|
2022-03-14 11:11:12 +00:00
|
|
|
asset_dir = "public"
|
|
|
|
|
|
|
|
|
|
[web.app]
|
|
|
|
|
|
|
|
|
|
# HTML title tag content
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
title = "project_name"
|
2022-03-14 11:11:12 +00:00
|
|
|
|
|
|
|
|
[web.watcher]
|
|
|
|
|
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
# When watcher is triggered, regenerate the `index.html`
|
|
|
|
|
reload_html = true
|
2022-03-14 11:11:12 +00:00
|
|
|
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
# Which files or dirs will be monitored
|
|
|
|
|
watch_path = ["src", "public"]
|
|
|
|
|
|
|
|
|
|
# Include style or script assets
|
2022-03-14 11:11:12 +00:00
|
|
|
[web.resource]
|
|
|
|
|
|
|
|
|
|
# CSS style file
|
|
|
|
|
style = []
|
|
|
|
|
|
|
|
|
|
# Javascript code file
|
|
|
|
|
script = []
|
|
|
|
|
|
|
|
|
|
[web.resource.dev]
|
|
|
|
|
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
# Same as [web.resource], but for development servers
|
2022-03-14 11:11:12 +00:00
|
|
|
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
# CSS style file
|
|
|
|
|
style = []
|
|
|
|
|
|
|
|
|
|
# JavaScript files
|
|
|
|
|
script = []
|
2022-03-14 11:11:12 +00:00
|
|
|
|
Improve CLI docs (#1404)
* 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>
2023-09-02 22:59:20 +00:00
|
|
|
[[web.proxy]]
|
|
|
|
|
backend = "http://localhost:8000/api/"
|
