Skip to content
Repository to manage AsTeRICS related documentation.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.audits
.certs
docs
public
src
.eslintrc.js
.gitignore
.gitmodules
Jenkinsfile
README.md
package.json
yarn.lock

README.md

AsTeRICS Docs

Documentation of AsTeRICS.

Dependencies

Install needed dependencies with

npm install

Release Instructions

Build current release with

npm run setup

and locate the result at dist/.

Note: enable verbose logging with by setting variable VERBOSE

VERBOSE=true npm run setup

Development Instructions

Setup and build individual versions using the provided cli tools (cf. CLI Reference)

# Initialize asterics-docs
$ npm run cli -- init

# Index all possible version (cf. src/config/config.js)
$ npm run cli -- index

# Setup docs folder of requested version
$ npm run cli -- setup -v 2.3 -o docs/

# Build set up version,..
$ VERSION=2.3 npx vuepress build docs/ -d dist/

# ..or host it with the development server
$ VERSION=2.3 npx vuepress dev docs/

Configuration Reference

Use variables in file .env to configure the builds

# Host IP address
HOST="127.0.0.1"

# Host port number
PORT=8000

# Path to documentation on server
ENDPOINT="docs"

CLI Reference

Start CLI tool, either using npm:

npm run cli <command>

Note: To pass commands and options, use -- after script command:

npm run cli -- -h

Alternatively, launch the script directly, using node:

node src/scripts/cli.js -h

Commands

npm run cli -- init  -h
npm run cli -- index -h
npm run cli -- setup -h
npm run cli -- clean -h
You can’t perform that action at this time.