@@ -16,21 +16,21 @@ To do so, all old files got moved into the `legacy` folder using `git mv`. This
1616To migrate a page from Jekyll to VitePress, you have to use the ` git mv ` command, to move the file from the ` legacy ` folder into the
1717new VitePress project located in ` src ` .
1818
19- ```
19+ ``` sh
2020git mv legacy/documentation/usersguide/config-incompat3to4.md src/documentation/usersguide/
2121```
2222
2323In the next step, edit the file, apply all the required changes and command your work.
2424
25-
2625## Run development server
2726
2827Please see the documentation of how to setup a local copy of the Naemon website.
2928
30- [ Run Naemon Website Locally ] ( ./documentation/developer/website.md )
29+ [ Run Naemon Website Locally] ( ./documentation/developer/website.md )
3130
3231### In a nutshell
33- ```
32+
33+ ``` sh
3434git clone https://github.com/naemon/naemon.github.io.git
3535cd naemon.github.io/
3636
@@ -39,18 +39,29 @@ npm run docs:dev
3939```
4040
4141### Using Docker
42+
4243In case you do not want to install Nodejs to your system, you can also use Docker
4344
4445First build the Docker image which will contain N Nodejs - thats all this documentation has no dependencies
45- ```
46+
47+ ``` sh
4648docker build . -t naemon/docs
4749```
4850
4951Now run the Docker container and navigate to ` http://127.0.0.1:5173 ` in your browser.
5052The container watches for file changes and will automatically regenerate the website if needed.
5153
52- ```
53- docker run --rm -it -v "$PWD":/site -p "5173:5173" naemon/docs:latest
54+ ``` sh
55+ docker run \
56+ --rm -it \
57+ -p 5173:5173 \
58+ --name=naemon-docs \
59+ -v $PWD :/opt/node_app/app \
60+ -v /opt/node_app/node_modules/ \
61+ -v /opt/node_app/app/.vitepress/cache \
62+ -v /opt/node_app/app/.vitepress/dist \
63+ -v $PWD /package.json:/opt/node_app/package.json \
64+ naemon/docs:latest
5465```
5566
5667### Important for the Migration
@@ -60,7 +71,6 @@ docker run --rm -it -v "$PWD":/site -p "5173:5173" naemon/docs:latest
60713 . You can modify HTML anchors like so: ` ## What Is Naemon? {#whatis} `
61724 . Add code blocks ` like this ` for code instead of quotes 'like so'.
6273
63-
6474### Goals and Motivation
6575
66761 . Get a dependency free documentation, (only Nodejs and VitePress) but no GitHub Pages, Jekyll and Ruby anymore.
0 commit comments