Skip to content

Jekyll theme for creating project documentation websites

License

Notifications You must be signed in to change notification settings

J3-Tech/doc-jekyll

Repository files navigation

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

# install dependencies
bundle install

# 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="/your-base/url" -t jekyll-doc-theme .

(or leave it empty for root: JEKYLL_BASEURL="") and serve it:

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

Projects using Jekyll Doc Theme

License

Released under the MIT license.

About

Jekyll theme for creating project documentation websites

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • SCSS 98.3%
  • HTML 1.4%
  • Other 0.3%