From eb362819e7b906c204772b0fc9eaab0a18315175 Mon Sep 17 00:00:00 2001 From: necessarylion Date: Sat, 30 Dec 2023 00:21:15 +0630 Subject: [PATCH] update doc about bin/dox command --- docs/assets/script.js | 0 docs/{css => assets}/style.css | 0 docs/digging-deeper/dox-cli.md | 3 +++ docs/the-basic/installation.md | 10 ++++++++++ mkdocs.yml | 4 +++- 5 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 docs/assets/script.js rename docs/{css => assets}/style.css (100%) diff --git a/docs/assets/script.js b/docs/assets/script.js new file mode 100644 index 0000000..e69de29 diff --git a/docs/css/style.css b/docs/assets/style.css similarity index 100% rename from docs/css/style.css rename to docs/assets/style.css diff --git a/docs/digging-deeper/dox-cli.md b/docs/digging-deeper/dox-cli.md index fb21bac..9c1e021 100644 --- a/docs/digging-deeper/dox-cli.md +++ b/docs/digging-deeper/dox-cli.md @@ -15,6 +15,9 @@ dart pub global activate dox export PATH="$PATH":"~/.pub-cache/bin" ``` +!!! tips + You can also use `bin/dox {command}` from your project folder to run server or create migration etc.. + ## Update package ```py diff --git a/docs/the-basic/installation.md b/docs/the-basic/installation.md index f64aa22..d6c7e3e 100644 --- a/docs/the-basic/installation.md +++ b/docs/the-basic/installation.md @@ -27,3 +27,13 @@ dox create new_blog --version v2.0.0 ```py https://github.com/dartondox/dox-sample/archive/refs/tags/v2.0.0.zip ``` + +## Start server + +```py +dox s + +or + +bin/dox s +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index af263c3..b40f856 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,7 +3,9 @@ repo_url: https://github.com/dartondox/dox-core site_url: https://dartondox.dev copyright: Copyright © 2023 - 2024 Dart On Dox extra_css: - - css/style.css + - assets/style.css +extra_javascript: + - assets/script.js extra: analytics: provider: google