(docs) removed Bower, use a CDN, Docker usage, updated Readme
This commit is contained in:
parent
b105d15f08
commit
ccbad6868d
@ -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`
|
|
||||||
|
@ -19,7 +19,7 @@ kramdown:
|
|||||||
input: GFM
|
input: GFM
|
||||||
syntax_highlighter: rouge
|
syntax_highlighter: rouge
|
||||||
|
|
||||||
exclude: ["bower.json", "README.md"]
|
exclude: ["README.md"]
|
||||||
collections:
|
collections:
|
||||||
pages:
|
pages:
|
||||||
output: true
|
output: true
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
---
|
---
|
||||||
layout: default
|
layout: default
|
||||||
---
|
---
|
||||||
<script src="{{site.github.url}}/bower_components/jquery/dist/jquery.min.js"></script>
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.slim.min.js"></script>
|
||||||
<script src="{{site.github.url}}/bower_components/anchor-js/anchor.js"></script>
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js"></script>
|
||||||
<script src="{{site.github.url}}/bower_components/bootstrap/js/affix.js"></script>
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js"></script>
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
|
|
||||||
document.addEventListener('DOMContentLoaded', function() {
|
document.addEventListener('DOMContentLoaded', function() {
|
||||||
|
@ -1,22 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "Spout",
|
|
||||||
"version": "0.0.1",
|
|
||||||
"authors": [
|
|
||||||
"Adrien Loison <aloison@box.com>"
|
|
||||||
],
|
|
||||||
"license": "Apache 2",
|
|
||||||
"private": true,
|
|
||||||
"ignore": [
|
|
||||||
"**/.*",
|
|
||||||
"node_modules",
|
|
||||||
"bower_components",
|
|
||||||
"test",
|
|
||||||
"tests"
|
|
||||||
],
|
|
||||||
"dependencies": {
|
|
||||||
"anchor-js": "~3.1.1"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"bootstrap": "~3.3.6"
|
|
||||||
}
|
|
||||||
}
|
|
13
docs/docker-compose.yml
Normal file
13
docs/docker-compose.yml
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
version: "3"
|
||||||
|
services:
|
||||||
|
site:
|
||||||
|
command: jekyll serve
|
||||||
|
image: jekyll/jekyll:latest
|
||||||
|
volumes:
|
||||||
|
- $PWD:/srv/jekyll
|
||||||
|
- $PWD/vendor/bundle:/usr/local/bundle
|
||||||
|
ports:
|
||||||
|
- 4000:4000
|
||||||
|
- 35729:35729
|
||||||
|
- 3000:3000
|
||||||
|
- 8080:4000
|
Loading…
x
Reference in New Issue
Block a user