/jekyll-doc-theme

Jekyll theme for creating project documentation websites

Primary LanguageCSSMIT LicenseMIT

Jekyll Doc Theme

Go to the website for detailed information and demo.

Running locally

You need Ruby and gem before starting, then:

# install bundler
gem install bundler

# clone the project
git clone https://github.com/aksakalli/jekyll-doc-theme.git
cd jekyll-doc-theme

# run jekyll with dependencies
bundle exec jekyll serve

Docker

Alternatively, you can deploy it using the multi-stage Dockerfile that serves files from Nginx for better performance in production.

Build the image for your site's JEKYLL_BASEURL:

docker build --build-arg JEKYLL_BASEURL="/" -t jekyll-doc-theme .

and serve it:

docker run -p 8080:80 jekyll-doc-theme

License

Released under the MIT license.