From a3e7cd3e27b5249f5cc510fce427b7f01686a986 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Tue, 3 Sep 2024 10:39:41 +0200 Subject: [PATCH] fix(README): better Docsy installation description --- README.md | 24 ++++++++++-------- {.devcontainer => assets/images}/browser.png | Bin {.devcontainer => assets/images}/terminal.png | Bin {.devcontainer => assets/images}/vsc-f1.png | Bin {.devcontainer => assets/images}/vsc-hugo.png | Bin 5 files changed, 14 insertions(+), 10 deletions(-) rename {.devcontainer => assets/images}/browser.png (100%) rename {.devcontainer => assets/images}/terminal.png (100%) rename {.devcontainer => assets/images}/vsc-f1.png (100%) rename {.devcontainer => assets/images}/vsc-hugo.png (100%) diff --git a/README.md b/README.md index 9c76060..689b0a9 100644 --- a/README.md +++ b/README.md @@ -23,28 +23,32 @@ To get a locally running documentation editing and presentation environment, fol #### Documentation language -The documentation is done in [Relearn-Syntax](https://mcshelby.github.io/hugo-theme-relearn/index.html). +The documentation is done in [Docsy-Theme](https://www.docsy.dev/). -So for editing content just goto the `content`-folder and edit content arrording to the [documentation language spec](https://mcshelby.github.io/hugo-theme-relearn/cont/index.html) +So for editing content just goto the `content`-folder and edit content arrording to the [Docsy documentation](https://www.docsy.dev/docs/adding-content/) ### Commiting After having finished a unit of work commit and push. -## Installation steps illustrated +## Annex + +### Installation steps illustrated When you run the above installation, the outputs could typically look like this: -### Steps 1-4 in the terminal +#### Steps 4/5 in Visual Studio Code -![terminal](.devcontainer/terminal.png) +##### Reopen in Container -### Steps 5/6 in Visual Studio Code +![vsc-f1](./assets/images/vsc-f1.png) -![vsc-f1](.devcontainer/vsc-f1.png) +##### Hugo server is running and (typically) listens to localhost:1313 -![vsc-hugo](.devcontainer/vsc-hugo.png) +After some installation time you have: -### Steps 6 in a web browser +![vsc-hugo](./assets/images/vsc-hugo.png) -![browser](.devcontainer/browser.png) +#### Steps 6 in a web browser + +![browser](./assets/images/browser.png) diff --git a/.devcontainer/browser.png b/assets/images/browser.png similarity index 100% rename from .devcontainer/browser.png rename to assets/images/browser.png diff --git a/.devcontainer/terminal.png b/assets/images/terminal.png similarity index 100% rename from .devcontainer/terminal.png rename to assets/images/terminal.png diff --git a/.devcontainer/vsc-f1.png b/assets/images/vsc-f1.png similarity index 100% rename from .devcontainer/vsc-f1.png rename to assets/images/vsc-f1.png diff --git a/.devcontainer/vsc-hugo.png b/assets/images/vsc-hugo.png similarity index 100% rename from .devcontainer/vsc-hugo.png rename to assets/images/vsc-hugo.png