README.md in jekyll-theme-tallneck-0.1.2 vs README.md in jekyll-theme-tallneck-0.2.0
- old
+ new
@@ -1,9 +1,11 @@
# Tallneck
-Tallneck is a Jeckyll theme for my personal blog. The name was inspired from one of the machines on my favorite game, Horizon Zero Dawn.
+Tallneck is a Jekyll theme for blogs. It is a simple and clean theme with a focus on the responsiveness. Also js free.
+Preview: [https://jekyll-theme-tallneck.pages.dev/](https://jekyll-theme-tallneck.pages.dev/)
+
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
@@ -16,74 +18,81 @@
theme: jekyll-theme-tallneck
```
And then execute:
- $ bundle
+```bash
+bundle
+```
Or install it yourself as:
- $ gem install jekyll-theme-tallneck
+```bash
+gem install jekyll-theme-tallneck
+```
-
## Usage
-### Customization
+### Initial setup
-Create a folder named `assets` in your Jekyll site's root directory.
-Then create a folder named `images` inside the `assets` folder and put a replacement for the default banner image named `banner.png` (1200x630) inside it.
+To set up your Jekyll site with the Tallneck theme, follow these steps:
-After that, replace the `favicon.ico` and `favicon.svg` file in the root directory with your own favicon.
+1. Install the theme as described above.
+2. Add the following to your site's `_config.yml` to activate the theme:
-Then, configure the various plugins in `_config.yml` to your liking. The plugins are:
+```yaml
+plugins:
+ - jekyll-remote-theme
+ - jekyll-feed
+ - jekyll-seo-tag
+ - jekyll-sitemap
-- [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
-- [jekyll-toc](https://github.com/toshimaru/jekyll-toc)
-- [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap)
+theme: jekyll-theme-tallneck
+```
-### Main pages
+3. Create the following files at the root of your Jekyll site and edit them like the ones in this repo:
+ - [index.md](index.md)
+ - [feed.md](feed.md)
+ - [404.md](404.md)
+ - [about.md](about.md)
+ - [cookie.md](cookie.md)
+ - [privacy.md](privacy.md)
+ - [terms.md](terms.md)
-Create at the root of your Jekyll site the following pages:
+4. Create the `assets/image` folder and put a replacement for the following images:
+ - `favicon.ico` and `favicon.svg` that will be used as the favicon.
+ - `logo.svg` that will be used as the home button.
+ - `pwa_icon.svg`, `pwa_icon_x512.png`, `pwa_icon_x96.png` that will be used as the PWA icon. ([https://maskable.app/editor](https://maskable.app/editor) can be used to create the maskable icon)
+5. In the `assets` folder, create the sitemanifest.json file and edit it to your liking.
+6. [Optional] Customize the theme by creating the `_sass` folder and editing `custom_variables.scss` and `custom_styles.scss` files.
+7. Edit the `_config.yml` file to your liking (you can use the [config](/_config.yml) file in this repo as a template).
-- `about.md`, which will be the About page and set the permalink to `/about`
-- `contact.md`, which will be the Contact page and set the permalink to `/contact`
-- `cookie.md`, which will be the Cookie Policy page and set the permalink to `/cookie`
-- `privacy.md`, which will be the Privacy Policy page and set the permalink to `/privacy`
-- `terms.md`, which will be the Terms of Service page and set the permalink to `/terms`
-Also create the file `404.html` with the following content:
-
-```yaml
----
-layout: 404
-sitemap: false
----
-```
-
### Writing posts
To create a new post, add a markdown file in the `_posts` directory and add at the top of the file the following:
```yaml
---
-layout: post
+layout: post # Optional, post is default
title: "First post!"
-subtitle: "Written in Go."
+subtitle: "Written in Go." # Optional
date: 2023-01-16 17:40:28 +0100
-image:
- path: /assets/images/golang.jpg
- alt: golang logo
+image: /assets/image/golang.jpg # Optional
---
```
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
-To add a custom directory to your theme-gem, please edit the regexp in `jotone_theme.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Some of the css code was inspired from the [Minima Theme](https://github.com/jekyll/minima). [Minima license](https://github.com/jekyll/minima/blob/master/LICENSE.txt).