yttt/yamatotoma.to
2
0
Fork 0
Code Pull requests Activity Actions

Make theme compatible with remote_theme (#590); fixes #339

Browse source
This commit is contained in:
Gabriel 2020-04-26 20:31:05 +02:00 • committed by GitHub
parent 3de196d57b
commit 4fa9fc8ad4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 33 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -32,7 +32,7 @@
Getting started is *literally* as easy as 1-2-3 :smile:
Scroll down to see the steps involved, but here is a 40-second video just as a reference as you work through the steps.
![Installation steps](img/install-steps.gif)
![Installation steps](assets/img/install-steps.gif)
### 0. Sign up to GitHub
@ -169,6 +169,19 @@ googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lob
gh-repo   | If you want to show GitHub buttons at the top of a post, this sets the GitHub repo name (eg. `daattali/beautiful-jekyll`). You must also use the `gh-badge` parameter to specify what buttons to show.
gh-badge | Select which GitHub buttons to display, available options are: [star, watch, fork, follow]. You must also use the `gh-repo` parameter to specify the GitHub repo.
### Use remote-theme (advanced)
It is possible to use the `remote_theme` feature of GitHub pages. To do so, instead of forking this project:
- Follow all the steps in https://guides.github.com/features/pages/ ***EXCEPT*** the ones where you chose the theme.
- add `remote_theme: daattali/beautiful-jekyll` to your `_config.yml`
- add `paginate: 5` (or any value you'd like) to your `_config.yml`. This is the only configuration value that is required.
- Optionally, if you want to use Staticman, you may need copy `_data/ui-text.yml` into your repo if you want to change the language.
Any folder or file that you don't include in your repository will be included by jekyll on build. If you want toreplace a file (css for instance), you'll just need to place it with the exact same path in own jekyll repo (e.g. `assets/css/main.css`)
### Advanced features (including how to use a custom URL address for your site)
I wrote [a blog post](https://deanattali.com/2015/03/12/beautiful-jekyll-how-to-build-a-site-in-minutes/) describing some more advanced features that I used in my website that are applicable to any Jekyll site. It describes how I used a custom URL for my site (deanattali.com instead of daattali.github.io), how to add a Google-powered search into your site, and provides a few more details about having an RSS feed.