steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2026-06-11 02:19:02 -06:00
Code Issues Packages Projects Releases Wiki Activity

Remove (theme)Dockerfile (#1299)

Browse Source 
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.
This commit is contained in:
Matt Wang
2025-01-06 00:44:16 -08:00
committed by GitHub
parent 676b33aefe
commit 1594ba6a73
3 changed files with 5 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -11
View File
@@ -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.
@@ -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