https://github.com/jekyll/jekyll-docs

Offline usage documentation for Jekyll. Requires Jekyll 3 and above.
https://github.com/jekyll/jekyll-docs

documentation jekyll offline

Last synced: 3 months ago
JSON representation

Offline usage documentation for Jekyll. Requires Jekyll 3 and above.

• Host: GitHub
• URL: https://github.com/jekyll/jekyll-docs
• Owner: jekyll
• License: mit
• Created: 2014-12-28T19:46:31.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2020-08-05T18:55:32.000Z (over 4 years ago)
• Last Synced: 2024-09-28T13:04:20.090Z (3 months ago)
• Topics: documentation, jekyll, offline
• Language: Ruby
• Homepage: https://rubygems.org/gems/jekyll-docs
• Size: 35.2 KB
• Stars: 38
• Watchers: 8
• Forks: 16
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.markdown
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
## jekyll-docs

This gem is how we ship the docs on jekyllrb.com to users who want local, offline access to the docs.

### Installing

Replace `` with the version of Jekyll you wish to use (e.g. `3.8.1`) and run:

```

gem install jekyll-docs -v 

```

Or, add it to your `Gemfile`:

```ruby

gem 'jekyll-docs', ''

```

Then, run `bundle install`.

### Usage

:warning: You can not generate the documentation website in an existing Jekyll source folder.

Once installed, you have to ensure you're using the same version of Jekyll and jekyll-docs:

```console

$ jekyll __ docs

$ # If you want Jekyll v3.8.1, you have to run:

$ jekyll _3.8.1_ docs

```

:smile:

### Building

```console

$ export JEKYLL_VERSION=3.8.1 # (or whatever)

$ bundle install

$ bundle exec rake build

```

Now you have it in `pkg/jekyll-docs-3.8.1.gem`.

### Releasing

Ensure the tag for the version is available on the `jekyll/jekyll` repo in the form of `vVERSION`, e.g. `v3.8.1`.

```console

$ export JEKYLL_VERSION=3.8.1

$ script/bootstrap

$ bundle exec rake release

```

Made a mistake? You can release another version of jekyll-docs by running

the following:

```console

$ export JEKYLL_VERSION=3.8.1

$ export JEKYLL_DOCS_VERSION=${JEKYLL_VERSION}.1 # Increment .1 to .2 if this is your second fix, etc.

$ script/bootstrap

$ bundle exec rake release

```