Skip to content

islos-efe-eme/documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation

CI status

CircleCI

Welcome to Los Santos

Ensure you have the following prerequisites installed:

Getting started

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.

New section

  1. Create a directory for your section: mkdir docs/my-section
  2. Create the entry point for your section: touch docs/my-section/README.md
  3. Add the route '/my-section/' to the array of routes in the configuration file .vuepress/config.js.
  4. The new section will be available under URL/my-section/.

Docker support

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.