Skip to content

AdamJ/almighty-devdoc

 
 

Repository files navigation

almighty-devdoc

Development documentation site for almighty.

Pushes to this site is automatically published to http://devdoc.almighty.io

Requirements

Install Docker.

How to run it

First we need to build the docker container for building the site. This takes a bit of time the first time, but afterwards it is fast.

$ cd almighty-devdoc
$ docker build -t almighty-devdoc-builder .

Then run the docker container to have it automatically generate and serve the site by running:

$ sh serve.sh

or if you prefer running the full line:

$ docker run -it --rm -p 4000:4000 -p 35729:35729 -v `pwd`:/almighty-devdoc almighty-devdoc-builder

This will automatically run jekyll with livereload enabled.

Goto http://localhost:4000 to see the generated ccontent and if you have livereload plugin installed the browser will automatically reload.

If you want finer control you can run bash directly:

$ docker run -it --rm -p 4000:4000 -p 35729:35729 -v `pwd`:/almighty-devdoc almighty-devdoc-builder /bin/bash

And from within here run rake or any other command.

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • CSS 69.2%
  • Ruby 10.6%
  • HTML 9.1%
  • Makefile 5.5%
  • Shell 5.5%
  • JavaScript 0.1%