Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pforret/jekyll_taxonomy
Generate tag and category pages for Jekyll static sites
https://github.com/pforret/jekyll_taxonomy
bash bashew jekyll static-site-generator taxonomy
Last synced: about 1 month ago
JSON representation
Generate tag and category pages for Jekyll static sites
- Host: GitHub
- URL: https://github.com/pforret/jekyll_taxonomy
- Owner: pforret
- License: mit
- Created: 2021-03-19T15:22:52.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-20T22:49:23.000Z (almost 3 years ago)
- Last Synced: 2024-11-14T06:46:51.698Z (3 months ago)
- Topics: bash, bashew, jekyll, static-site-generator, taxonomy
- Language: Shell
- Homepage: https://blog.forret.com/github/2021/03/21/create-tag-category-pages-jekyll/
- Size: 740 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://basher.gitparade.com/package/)
# jekyll_taxonomy
Generate a separate page for each tag/category/author/... pages for Jekyll static site generator (e.g. for Github Pages). Topical index pages for tags, categories, ... are great for your readers and for SEO.
## 🔥 Usage
```
Program: jekyll_taxonomy 1.2.2 by [email protected]
Updated: Oct 21 15:37:34 2021
Description: Generate tag and category pages for Jekyll SSG
Usage: jekyll_taxonomy
[-h] [-q] [-v] [-f] [-c]
[-l ] [-t ] [-p ] [-y ] [-o ]
Flags, options and parameters:
-h|--help : [flag] show usage [default: off]
-q|--quiet : [flag] no output [default: off]
-v|--verbose : [flag] output more [default: off]
-f|--force : [flag] do not ask for confirmation (always yes) [default: off]
-c|--cleanup : [flag] clean the output folder first [default: off]
-l|--log_dir > : [option] folder for log files [default: /Users/pforret/log/jekyll_taxonomy]
-t|--tmp_dir > : [option] folder for temp files [default: /tmp/jekyll_taxonomy]
-p|--post_dir >: [option] input folder with Jekyll posts [default: _posts]
-y|--layout_dir >: [option] folder with Jekyll layouts [default: _layouts]
-o|--collection >: [option] collection name (_posts -> posts)
: [parameter] action to perform generate/check/update
: [parameter] tag/category/author/... (optional)
: [parameter] output folder [default: /] (optional)
### TIPS & EXAMPLES
* use jekyll_taxonomy generate tag to generate all tag documents
* use jekyll_taxonomy check to check if this script is ready to execute and what values the options/flags are
* use jekyll_taxonomy env to generate an example .env file
* use jekyll_taxonomy update to update to the latest version
* >>> bash script created with pforret/bashew
* >>> for bash development, also check out pforret/setver and pforret/progressbar
```
## 🧪 Examples
* `jekyll_taxonomy generate tag`: generate a tag index page for each unique tag defined by `tag:` or `tags:` in your posts' front matter. All tags are lowercase and slugified (Apple -> apple, FIRST TRY! -> first-try). The index page will list all _posts with that tag, with a title, date and excerpt. Also, a layout `with_tag` is created in `_layouts` and a index page `index.html`, listing all tags, is created in the `tag` folder.
* `jekyll_taxonomy -p _products -y _templates generate age age_group`: generate an age index page in the folder _`age_group` for each unique age group defined by `age:` or `ages:` in your products' front matter. All tags are lowercase and slugified (Adult -> adult, Baby Girl -> baby-girl). Also, a layout `with_age` is created in `_templates` and an index page `index.html` is created in the `age_group` folder.
* `jekyll_taxonomy -c generate category`: first remove all .md pages from the category folder and then recreate them from the posts (defined by `category:` and `categories:`in the front matter). Useful when categories (could) have disappeared because e.g. some posts were deleted or categories were renamed.
* `tag/index.html` can be modified to e.g. separate tag listing on 1st letter, or use a Bootstrap/Tailwind specific layout
* `_layouts/with_tag.html` can be modified to e.g. remove the excerpt or make it longer, to add the author, or use a Bootstrap/Tailwind specific layout
I use it on my Jekyll blog:
* [blog.forret.com/category/](https://blog.forret.com/category/) for the category listing
* [blog.forret.com/category/github/](https://blog.forret.com/category/github/) for the index page for category 'github'
* [blog.forret.com/tag/](https://blog.forret.com/tag/) for the tag listing (with a more compact format)
* [blog.forret.com/tag/bash/](https://blog.forret.com/tag/bash/) for the index page of the tag 'bash'
These are generated by the following script:
```bash
jekyll_taxonomy -c generate tag
git add tag ## add any new tag indexes to git
jekyll_taxonomy -c generate category
git add category ## add any new category indexes to git
git status ## show me added/removed tags and categories
```
## 🚀 Installation
with [basher](https://github.com/basherpm/basher)
$ basher install pforret/jekyll_taxonomy
or with `git`
$ git clone https://github.com/pforret/jekyll_taxonomy.git
$ cd jekyll_taxonomy
## 📝 Acknowledgements
* script created with [bashew](https://github.com/pforret/bashew)
© 2021 Peter Forret