aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/.docs/content/1.introduction/1.getting-started.md
diff options
context:
space:
mode:
author简律纯 <hsiangnianian@outlook.com>2023-04-19 17:30:39 +0800
committer简律纯 <hsiangnianian@outlook.com>2023-04-19 17:30:39 +0800
commit3adc965dd09490b7efa1cce9f09b0a3b30970277 (patch)
treef813abb07d7b003984aa74e3154752b6ffc3ccd5 /docs/.docs/content/1.introduction/1.getting-started.md
parentc7c9ca6f0c8eddf6d34cd40779f3b2d9463f3a46 (diff)
downloadHydroRoll-3adc965dd09490b7efa1cce9f09b0a3b30970277.tar.gz
HydroRoll-3adc965dd09490b7efa1cce9f09b0a3b30970277.zip
✨优化文档
Diffstat (limited to 'docs/.docs/content/1.introduction/1.getting-started.md')
-rw-r--r--docs/.docs/content/1.introduction/1.getting-started.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/.docs/content/1.introduction/1.getting-started.md b/docs/.docs/content/1.introduction/1.getting-started.md
new file mode 100644
index 0000000..4c08c14
--- /dev/null
+++ b/docs/.docs/content/1.introduction/1.getting-started.md
@@ -0,0 +1,57 @@
+# Getting Started
+
+From your Markdown files to a deployed website in few minutes.
+
+## Play online
+
+You can start playing with Docus in your browser using Stackblitz:
+
+:button-link[Play on StackBlitz]{size="small" icon="IconStackBlitz" href="https://stackblitz.com/github/nuxt-themes/docus-starter" blank}
+
+## Create a new project
+
+1. Start a fresh Docus project with:
+
+```bash [npx]
+npx nuxi@latest init docs -t themes/docus
+```
+
+2. Install the dependencies in the `docs` folder:
+
+::code-group
+
+ ```bash [npm]
+ npm install
+ ```
+
+ ```bash [yarn]
+ yarn install
+ ```
+
+ ```bash [pnpm]
+ pnpm install --shamefully-hoist
+ ```
+
+::
+
+3. Run the `dev` command to start Docus in development mode:
+
+::code-group
+
+```bash [npm]
+npm run dev
+```
+
+```bash [yarn]
+yarn dev
+```
+
+```bash [pnpm]
+pnpm run dev
+```
+
+::
+
+::alert{type="success"}
+✨ Well done! A browser window should automatically open for <http://localhost:3000>
+::