CI status
Welcome to Los Santos
Ensure you have the following prerequisites installed:
- Node Erbium (v12.x LTS) from https://nodejs.org/en/
- Yarn
Clone the repository:
$ git clone https://github.com/islos-efe-eme/documentation
$ cd documentation
Yarn scripts reference
Command | Description |
---|---|
docs:dev |
Local development server in localhost:8080 + auto-reload. |
docs:build |
Production build. |
- Create a directory for your section:
mkdir docs/my-section
- Create the entry point for your section:
touch docs/my-section/README.md
- Add the route
'/my-section/'
to the array of routes in the configuration file.vuepress/config.js
. - The new section will be available under
URL/my-section/
.
Use the provided Dockerfile
to build the image and run a container.
$ docker build --rm -f "Dockerfile" -t documentation:latest "."
$ docker run --rm -d -p 8080:8080/tcp documentation:latest
Visit http:https://localhost:8080 on your browser.