Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamranahmedse/github-pages-blog-action
Create good looking blog from your markdown files in a GitHub repository
https://github.com/kamranahmedse/github-pages-blog-action
actions blog github-actions markdown markdown-blog
Last synced: about 1 month ago
JSON representation
Create good looking blog from your markdown files in a GitHub repository
- Host: GitHub
- URL: https://github.com/kamranahmedse/github-pages-blog-action
- Owner: kamranahmedse
- License: mit
- Created: 2022-05-22T16:47:54.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-31T14:36:53.000Z (over 1 year ago)
- Last Synced: 2024-10-01T15:47:43.964Z (2 months ago)
- Topics: actions, blog, github-actions, markdown, markdown-blog
- Language: CSS
- Homepage:
- Size: 648 KB
- Stars: 84
- Watchers: 5
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license
Awesome Lists containing this project
- project-awesome - kamranahmedse/github-pages-blog-action - Create good looking blog from your markdown files in a GitHub repository (CSS)
README
Github Pages Blog
Create good looking blog from your markdown files on GitHub
## Usage Example
* [Codebase](https://github.com/kamranahmedse/kamranahmedse.github.io)
* [Live Blog](https://kamranahmed.info)
## Setting Up the Blog
Create a repository on GitHub to hold your blog content with the following directory structure:
```shell
├── about.md
├── posts
├── art-of-getting-better.md
├── behavior-of-links-created-using-javascript.md
└── yellow-fade-technique-in-css.md
├── site.json
└── static
├── resume.pdf
└── ebook.pdf
```
### About Page
`about.md` is the markdown file containing the content for your about page.
### Blog Posts
`posts/` is the directory containing all your blog posts in markdown format. It supports the following frontmatter on top of each of the blog post
```shell
---
title: Your Personal Blog on GitHub Pages
date: 2022-05-25
permalink: /personal-blog-ghpages
---
Content for your bog post
```
Where `title` is the blog post title shown on the homepage as well as on the post detail page. `date` is the blog post date. `permalink` is the optional parameter to let you override the slug of the blog post.
### Site Configuration
`site.json` contains the configuration to setup the blog. Given below is the sample JSON configuration.
```json
{
"title": "Kamran Ahmed",
"subtitle": "Lead engineer at Zalando — tech guy with an entrepreneurial spirit and knack for getting things done",
"owner": {
"name": "Kamran Ahmed",
"email": "[email protected]"
},
"social": {
"github": "kamranahmedse",
"medium": "kamranahmedse",
"twitter": "kamranahmedse"
},
"newsletter": {
"currentCount": "2,000",
"revueUsername": "roadmapsh"
},
"seo": {
"title": "Kamran Ahmed",
"description": "Blog of a Software Engineer",
"author": "Kamran Ahmed",
"keywords": [
"blog",
"developer blog",
"engineering blog"
]
},
"cname": "kamranahmed.info"
}
```
For the `newsletter`, you can remove the object if you don't have [revue newsletter](https://www.getrevue.co/). And `cname` is your personal domain if applicable.
### Static Assets
The contents of the `static` folder will simply be copied at the root of your blog and will be accessible via `http://[blogurl]/filename`
## Setting Up GitHub Action
Once you have the blog repository setup, you need to setup the GitHub action in your repository. Create the action file at `.github/workflows/deploy.yml` with the following content
```yaml
name: Build and Deploy
on: [push]
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Deploy
uses: kamranahmedse/[email protected]
with:
branch: gh-pages # Optional branch for GitHub Pages
```