From ccbad6868db3a3198f74d9ceb5c9c91ff2913436 Mon Sep 17 00:00:00 2001 From: madflow Date: Thu, 28 Jun 2018 11:36:07 +0200 Subject: [PATCH] (docs) removed Bower, use a CDN, Docker usage, updated Readme --- docs/README.md | 22 ++++++++++++++++------ docs/_config.yml | 2 +- docs/_layouts/doc.html | 6 +++--- docs/bower.json | 22 ---------------------- docs/docker-compose.yml | 13 +++++++++++++ 5 files changed, 33 insertions(+), 32 deletions(-) delete mode 100755 docs/bower.json create mode 100644 docs/docker-compose.yml diff --git a/docs/README.md b/docs/README.md index 5ff10af..ee8a572 100755 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,17 @@ -Spout Github pages -==== +# Spout Documentation + +## Quickstart + +1. Install `jekyll`: `sudo gem install jekyll` +2. Run the site locally: `jekyll serve` + +## Usage with Docker and Docker Compose + +* Install Docker and Docker Compose +* Run ```docker-compose up``` +* Point your browser at [http://127.0.0.1:8080/](http://127.0.0.1:8080/) + +## Editing the documentation + +* All documents relevant for the documentation are located in the ```_pages``` folder. -1. Install `bower`: `npm install -g bower` or `yarn global add bower` or -2. Install dependencies: `bower install` -3. Install `jekyll`: `sudo gem install jekyll` -4. Run the site locally: `jekyll serve` diff --git a/docs/_config.yml b/docs/_config.yml index 66d421a..8244aa4 100755 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -19,7 +19,7 @@ kramdown: input: GFM syntax_highlighter: rouge -exclude: ["bower.json", "README.md"] +exclude: ["README.md"] collections: pages: output: true diff --git a/docs/_layouts/doc.html b/docs/_layouts/doc.html index b46fdaa..0c1df25 100755 --- a/docs/_layouts/doc.html +++ b/docs/_layouts/doc.html @@ -1,9 +1,9 @@ --- layout: default --- - - - + + +