No description, website, or topics provided.
Branch: gh-pages
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_data
_docs
_includes
_layouts
_posts
_sass
css
fonts
img
js
.DS_Store
.editorconfig
.gitignore
404.html
CNAME
Dockerfile
Gemfile
Gemfile.lock
LICENSE
README.md
_config.yml
about.html
allposts.html
favicon.ico
favicon.ico.orig
gear.html
index.html
membership.html
nginx.conf
schedule.html
search.json

README.md

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.