Improve docs for local dev

This commit is contained in:
Adrien Loison 2019-10-17 11:23:56 +02:00 committed by Adrien Loison
parent 74146c6224
commit 8a2dcc946b
4 changed files with 13 additions and 4 deletions

7
docs/_config_local.yml Normal file
View File

@ -0,0 +1,7 @@
# Github Metadata plugin
repository: box/spout
plugins:
- "jekyll-github-metadata"
github:
url: http://localhost:8080

View File

@ -11,7 +11,7 @@
<div class="footer-col footer-col-2">
<ul class="social-media-list">
<li><a href="https://github.com/box/spout/issues"><span class="icon icon--github">{% include icon-github.svg %}</span><span class="username">GitHub Issues</span></a></li>
<li><a href="{{ site.github.issues_url }}"><span class="icon icon--github">{% include icon-github.svg %}</span><span class="username">GitHub Issues</span></a></li>
</ul>
</div>

View File

@ -16,7 +16,7 @@
<a class="page-link" href="{{ site.github.url }}/docs/">Documentation</a>
<a class="page-link" href="{{ site.github.url }}/guides/">Guides</a>
<a class="page-link" href="{{ site.github.url }}/faq/">FAQ</a>
<a class="page-link" href="https://github.com/box/spout">
<a class="page-link" href="{{ site.github.repository_url }}">
<span class="icon icon--github">{% include icon-github.svg %}</span>
<span class="username">GitHub</span>
</a>

View File

@ -1,7 +1,9 @@
version: "3"
services:
site:
command: jekyll serve
command: bash -c "
gem install 'jekyll-github-metadata'
&& jekyll serve --config _config.yml,_config_local.yml"
image: jekyll/jekyll:latest
volumes:
- $PWD:/srv/jekyll
@ -10,4 +12,4 @@ services:
- 4000:4000
- 35729:35729
- 3000:3000
- 8080:4000
- 8080:4000