Skip to content

Commit

Permalink
Remove (theme)Dockerfile (just-the-docs#1299)
Browse files Browse the repository at this point in the history
It doesn't seem like any of our theme developers use this (out of date) `Dockerfile`, and we're probably better served placing more of this in the theme template (so users can consume it). I think this is part of our overall movement to not have users of our theme directly clone this repo.
  • Loading branch information
mattxwang authored Jan 6, 2025
1 parent 676b33a commit 1594ba6
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 37 deletions.
12 changes: 0 additions & 12 deletions Dockerfile

This file was deleted.

16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ More specifically, the created site:

Other than that, you're free to customize sites that you create with the template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.

### Use RubyGems
### Use as a Ruby Gem

Alternatively, you can install the theme as a Ruby Gem, without creating a new site.

Expand All @@ -48,17 +48,11 @@ And add this line to your Jekyll site's `_config.yml`:
theme: just-the-docs
```
And then execute:
And then install all relevant dependencies:
$ bundle
Or install it yourself as:
$ gem install just-the-docs
Alternatively, you can run it inside Docker while developing your site
$ docker-compose up
```shell
$ bundle
```

## Usage

Expand Down
14 changes: 0 additions & 14 deletions docker-compose.yml

This file was deleted.

0 comments on commit 1594ba6

Please sign in to comment.