DevFW-CICD/website-and-documentation
23
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(README): better Docsy installation description

Browse source
This commit is contained in:
Stephan Lo 2024-09-03 10:39:41 +02:00
parent 685cf2e5d1
commit a3e7cd3e27
5 changed files with 14 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -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)