Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kannansuresh/jekyll-blog-archive-workflow
Jekyll Archives workflow action. This action brings archive feature to Jekyll blogs hosted on GitHub pages.
https://github.com/kannansuresh/jekyll-blog-archive-workflow
archive jekyll jekyll-archives jekyll-blog
Last synced: 3 months ago
JSON representation
Jekyll Archives workflow action. This action brings archive feature to Jekyll blogs hosted on GitHub pages.
- Host: GitHub
- URL: https://github.com/kannansuresh/jekyll-blog-archive-workflow
- Owner: kannansuresh
- Created: 2020-08-08T10:04:00.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T04:05:48.000Z (almost 2 years ago)
- Last Synced: 2024-07-09T08:47:19.056Z (4 months ago)
- Topics: archive, jekyll, jekyll-archives, jekyll-blog
- Language: HTML
- Homepage: https://aneejian.com
- Size: 189 KB
- Stars: 15
- Watchers: 1
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome - kannansuresh/jekyll-blog-archive-workflow - Jekyll Archives workflow action. This action brings archive feature to Jekyll blogs hosted on GitHub pages. (HTML)
README
# Jekyll Archives Workflow
This workflow action helps in automatically creating archives for GitHub pages built with Jekyll.
## Blog Configuration
### Create a collection
- Open `_config.yml` file to edit your configuration.
- Add a collection to the configuration like below.
```yml
# Archives
collections:
archives:
output: true
permalink: /archives/:path/
```
___
### Setup `_archives` folder
- Create a folder `_archives` in your GitHub pages root.
- Create a text file `archivedata.txt` with the below code.
```liquid
---
---
{
"categories": [
{%- for category in site.categories -%}
"{{ category[0]}}"{% unless forloop.last %},{% endunless %}
{%- endfor -%}
],
"tags": [
{%- for tag in site.tags -%}
"{{ tag[0] }}"{% unless forloop.last %},{% endunless %}
{%- endfor -%}
],
"years": [
{%- for post in site.posts -%}
"{{ post.date | date: "%Y" }}"{% unless forloop.last %},{% endunless %}
{%- endfor -%}
]
}
```
#### Test the setup
- Build your site and see if you can see the archive data by navigating to your site. `(yoursite.com/archives/archivedata)`
- You should see a `json` structure like the below one.
```json
{
"categories": [
"Software Testing",
"Excel",
"Blogging",
"Programming",
"Quiz",
"Photography",
"RPA"
],
"tags": [
"Automation Testing",
"UFT",
"QTP",
"Excel VBA"
],
"years": [
"2020",
"2020",
"2019",
"2018",
"2017"
]
}
```
> File was formatted for better reading. This will appear minified on your site.
### Setup `_layouts` folder
- Create 3 layouts in the `_layouts` folder.
- `archive-categories.html`
- `archive-tags.html`
- `archive-years.html`
> Sample layouts and files are present in the folder [`blog-files`](/blog-files/_layouts) of this repository. If you are using it make sure to include a file from [`_includes`](/blog-files/_includes) folder too.
> Do not rename the files in the `_layouts` folder.
___
## 2. Setup a new action
- Got to your blog repository.
- Create a folder named `.github` and create `workflows` folder inside it if it doesn't exist.
- Create a new file named `add_archives.yml` in the `workflows` folder. You can name it anything you want.
- Add the following code inside the file.
```yml
name: Generate Jekyll Archives
# description: Generate categories, tags and years archive files.
on:
workflow_dispatch:
push:
paths:
- "_posts/**"
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Jekyll Blog Archive
uses: kannansuresh/[email protected]
with:
archive_url: "https://yoursite.com/archives/archivedata"
archive_folder_path: "_archives"
- name: setup git config
run: |
git config user.name "GitHub Actions Bot"
git config user.email "<>"
- name: commit
run: |
git add --all
git commit -m "Created and updated archive files." || echo "No changes to commit."
git push origin master || echo "No changes to push."
```
### Variables
| Variable Name | Description |Required |
|--|--|--|
| `archive_url` | Your blog's archive data URL. e.g. `yoursite.com/archives/archivedata` | Yes |
|`archive_folder_path`|Path to your `_archives` folder. Default value `_archives`|Yes|
> In the code above, make sure to change the variable `archive_url` to your site's archive data URL.
> By default, the code pushes changes to `master` branch. Change the code if you want the changes to be pushed to a different branch.
> The action is set to run every time a commit happens in your `_posts` folder.
- To trigger the action manually
- Navigate to `Actions` tab.
- Select `Generate Jekyll Archives`.
- Select `Run workflow` and run it.
- Wait for the run to complete.
- After a successful run, navigate to `_archives` folder and you will see the archive files generated.
To view the archives on your site, use the following URLs.
- For categories: `yoursite.com/category/category_name`
- For tags: `yoursite.com/tag/tag_name`
- For categories: `yoursite.com/year/2020`
## See it in action
I have implemented this on my website [Aneejian](https://aneejian.com)
See the below URLs.
- [https://aneejian.com/category/rpa](https://aneejian.com/category/rpa)
- [https://aneejian.com/tag/jekyll](https://aneejian.com/tag/jekyll)
- [https://aneejian.com/year/2020](https://aneejian.com/year/2020)