rzen/jekyll-theme-isabelline
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

alternate readme, to be reconsiled with the post

Browse Source
This commit is contained in:
rzen
2019-09-06 07:17:53 -04:00
parent f08238db34
commit 297be0928b
1 changed files with 61 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
_pages/read-me.md
View File

@@ -1,9 +1,10 @@
---
title: Read me
layout: post
title: README
layout: page
date: 2019-07-22
tags: readme wip
categories: global
permalink: /readme/
categories: xglobal
---
# jekyll-theme-isabelline
@@ -12,26 +13,72 @@ Simple clean mobile-friendly theme for long form blogging. Also good for private
## Installation
Fundamentally setting up a jekyll website with a theme is a straightforward process.
Start with a jekyll website ([new](#how-to-create-new-jekyll-website) or existing).
1. Start with a website ([new](#how-to-create-new-jekyll-website) or existing).
Update Gemfile to reference the new theme and plugins it requires:
2. Update Gemfile to reference the new theme and plugins it requires
```ruby
# ...
gem "jekyll-theme-isabelline", "~> 1.0.0"
3. (Optionally) Backup previous configs.
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.6"
gem 'jekyll-tidy'
gem 'jekyll-tagging'
gem 'jekyll-mentions'
gem 'jekyll-sitemap'
gem 'jekyll-feed'
gem 'jekyll-seo-tag'
end
# ...
```
4. Copy `isabelline`'s starter `_config.yaml` and customize it to your liking.
(Optionally) Backup your `_config.yaml`, e.g.:
5. Create the following folders for your future contents: `_blog`, `_drafts`, `_pages`, `_posts`, and `_private`. The latter is for private notes which will only be rendered in [local mode](#local-mode).
```sh
cp _config.yaml _config.yaml.backup
```
6. Run bundle install.
Copy `isabelline`'s starter `_config.yaml` and customize it to your liking:
```sh
curl https://git.rzen.dev/rzen/jekyll-theme-isabelline/raw/branch/master/_config.yaml -o _config.yaml
```
Create the following folders for your future contents: `_blog`, `_drafts`, `_pages`, `_posts`, and `_private`. The latter is for private notes which will only be rendered in [local mode](#local-mode):
```sh
mkdir _blog _drafts _pages _posts _private
```
Also note that `/_private` is included in `.gitignore` (along with `_drafts`).
Copy `docker-compose.yaml`, `.gitignore` and `index.html` file into the root of your website:
```sh
curl https://git.rzen.dev/rzen/jekyll-theme-isabelline/raw/branch/master/docker-compose.yaml -o docker-compose.yaml
curl https://git.rzen.dev/rzen/jekyll-theme-isabelline/raw/branch/master/.gitignore -o .gitignore
curl https://git.rzen.dev/rzen/jekyll-theme-isabelline/raw/branch/master/index.html -o index.html
```
Run bundle install:
```sh
docker-compose run bundle install
```
## Docker cookbook
### <a id="how-to-create-new-jekyll-website"></a>How to create a new jekyll website
```sh
$ docker run --rm -it -v "$PWD:/srv/jekyll" jekyll/jekyll:3.8 jekyll new .
docker run --rm -it -v "$PWD:/srv/jekyll" jekyll/jekyll:3.8 jekyll new .
```
ALternatively you may run this command using docker compose:
```sh
docker-compose run jekyll new .
```
### How to backup previous configs
@@ -62,7 +109,7 @@ Fundamentally setting up a jekyll website with a theme is a straightforward proc
To run jekyll in local development mode:
```sh
$ docker-compose up jekyll-serve
docker-compose up jekyll-serve
```
To push gem to [rubygems.org](https://rubygems.org):
@@ -174,7 +221,7 @@ RubyGems Environment:
And to run bundle:
```sh
$ docker-compose run bundle help
docker-compose run bundle help
[ .. skipped budnle help output for brevity .. ]
```
@@ -201,7 +248,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/rzen/j
To develop and test simply run from the root of a cloned `jekyll-theme-isabelline` project:
```sh
$ docker-compose up jekyll-serve
docker-compose up jekyll-serve
```
## License