Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/h-enk/doks.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHenk Verlinde <henk@ventizo.com>2020-12-03 18:07:04 +0300
committerHenk Verlinde <henk@ventizo.com>2020-12-03 18:07:04 +0300
commit63ca41e1076375eb99aad5ca6d77d95516b6f349 (patch)
treeb44176a216728f71a826977e9f1ec0dd1d5b26ec /README.md
parent0377b0de75a3cc8027bd255961f6d0c184d82575 (diff)
docs: update content
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/README.md b/README.md
index 854811e..755d13a 100644
--- a/README.md
+++ b/README.md
@@ -32,32 +32,34 @@ Nine reasons why you should use Doks:
Make sure all dependencies have been installed:
-- [Hugo](https://gohugo.io/) >= 0.75.0/extended
+- [Hugo](https://gohugo.io/getting-started/installing/) >= 0.75.0/extended (needed for SCSS processing support)
- [Node.js](https://nodejs.org/) >= 14.15.0 (needed to install npm packages and run commands)
## Get started
-Create a new Doks project:
+Have your Doks site in three steps:
+
+### 1. Create a new Doks project:
```bash
git clone https://github.com/h-enk/doks.git my-doks-site
```
-Install npm packages:
+### 2. Install npm packages:
```bash
npm install
```
-Start local development server:
+### 3. Start local development server:
```bash
npm run start
```
-### Other commands
+## Other commands
-Doks comes with [commands for most used tasks](https://getdoks.org/docs/prologue/commands/).
+Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks.
## Quick start
@@ -67,7 +69,7 @@ Get your Doks site in 1 min.
## Example site
-👉 [doks.netlify.app](https://doks.netlify.app/)
+- [doks.netlify.app](https://doks.netlify.app/)
## Documentation