Skip to content

Commit

Permalink
Update README with GH Pages, MkDocs info and screenshot.
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosperate committed Nov 23, 2019
1 parent 044c3ef commit 861487d
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ verify_ssl = true
mkdocs = "*"

[requires]
python_version = "3.6"
python_version = "3"
10 changes: 5 additions & 5 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,30 @@

Port of the Read the Docs theme to Jekyll to use with GitHub Pages.

This theme is currently a **Work-In-Progress**, and while things might be
broken it should be already usable.
![screenshot](assets/img/screenshot.png)

This theme is currently a **Work-In-Progress** but, while some things might be
broken, it should be already usable.

This theme is ported from the MkDocs port of the Read The Docs Sphinx theme.
Full license and copyright information can be found in the
[License](#license) section.


## Using with GitHub Pages

Add a `_config.yml` file to your GitHub pages repository (`master`/`gh-pages`
branch or inside a `docs` folder, depending on your GitHub repository settings)
with this line:

```yml
remote_theme: carlosperate/jekyll-theme-rtd
```
There are more configuration options explain in the docs, or you can have a
look at the [_config.yml file from this repo](docs/_config.yml).
## Add this theme to your Jekyll project
Add this line to your Jekyll site's `Gemfile`:
Expand Down Expand Up @@ -94,10 +110,18 @@ $ bundle install

### Build with MkDocs for comparison

To compare the output from MkDocs:
As this theme has been ported from the MkDocs port, it can be useful to run
MkDocs on the same markdown files and compare its output to the Jekyll
output. A `mkdocs.yml` file is included to configure the project.

Pipenv has been used in this case to manage Python dependencies:

```bash
$ mkdocs build
$ pip install pipenv
$ pipenv install
$ pipenv run mkdocs build
$ cd _site_mkdocs
$ pipenv run python -m http.server 8080
```


Expand Down
Binary file added assets/img/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 861487d

Please sign in to comment.