mirror of
https://github.com/IT4Change/IT4C.dev.git
synced 2025-12-13 09:25:49 +00:00
update readme
This commit is contained in:
parent
b864cea8cf
commit
05bdc3f6cc
35
README.md
35
README.md
@ -1,2 +1,35 @@
|
||||
# IT4C.dev
|
||||
IT4C.dev Website
|
||||
|
||||
This repository contains the https://IT4C.dev Website utilizing `vuepress` to generate it.
|
||||
|
||||
## Software requirements
|
||||
|
||||
This package requires:
|
||||
- nodejs
|
||||
- npm
|
||||
|
||||
## Techstack
|
||||
|
||||
This package uses:
|
||||
- vuepress
|
||||
- vuepress-theme-book
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
How to use this package
|
||||
|
||||
### Build
|
||||
|
||||
Build the static files of the website which then can be found under `docs/.vuepress/dist/`.
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
|
||||
### Dev
|
||||
|
||||
Bring up a development environment with hot reloading which can be reached under http://localhost:8080/
|
||||
|
||||
```
|
||||
npm run dev
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user