{"id":13548241,"url":"https://github.com/kamranahmedse/github-pages-blog-action","last_synced_at":"2025-04-26T14:13:29.606Z","repository":{"id":37385512,"uuid":"495119482","full_name":"kamranahmedse/github-pages-blog-action","owner":"kamranahmedse","description":"Create good looking blog from your markdown files in a GitHub repository","archived":false,"fork":false,"pushed_at":"2023-08-31T14:36:53.000Z","size":664,"stargazers_count":92,"open_issues_count":5,"forks_count":19,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-26T10:09:05.212Z","etag":null,"topics":["actions","blog","github-actions","markdown","markdown-blog"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kamranahmedse.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"kamranahmedse"}},"created_at":"2022-05-22T16:47:54.000Z","updated_at":"2025-04-11T12:35:31.000Z","dependencies_parsed_at":"2024-01-16T18:23:46.401Z","dependency_job_id":null,"html_url":"https://github.com/kamranahmedse/github-pages-blog-action","commit_stats":{"total_commits":43,"total_committers":1,"mean_commits":43.0,"dds":0.0,"last_synced_commit":"14a6b4526adb015afff2dedfad12c1405784cb9c"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kamranahmedse%2Fgithub-pages-blog-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kamranahmedse%2Fgithub-pages-blog-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kamranahmedse%2Fgithub-pages-blog-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kamranahmedse%2Fgithub-pages-blog-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kamranahmedse","download_url":"https://codeload.github.com/kamranahmedse/github-pages-blog-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250976097,"owners_count":21516878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","blog","github-actions","markdown","markdown-blog"],"created_at":"2024-08-01T12:01:07.775Z","updated_at":"2025-04-26T14:13:29.582Z","avatar_url":"https://github.com/kamranahmedse.png","language":"CSS","funding_links":["https://github.com/sponsors/kamranahmedse"],"categories":["CSS"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg height=\"150\" src=\"./.github/assets/flash.png\" /\u003e\n  \u003ch2 align=\"center\"\u003eGithub Pages Blog\u003c/h2\u003e\n  \u003cp align=\"center\"\u003eCreate good looking blog from your markdown files on GitHub\u003cp\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://kamranahmed.info\"\u003e\n    \t\u003cimg src=\"https://img.shields.io/badge/-Visit%20Sample%20Blog%20‎ ‎ -teal.svg?style=flat\u0026colorA=teal\" alt=\"kamranahmed.info\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"license\"\u003e\n    \t\u003cimg src=\"https://img.shields.io/badge/License-MIT-0a0a0a.svg?style=flat\u0026colorA=0a0a0a\" alt=\"license mit\" /\u003e\n    \u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n## Usage Example\n\n* [Codebase](https://github.com/kamranahmedse/kamranahmedse.github.io)\n* [Live Blog](https://kamranahmed.info)\n\n\n## Setting Up the Blog\n\nCreate a repository on GitHub to hold your blog content with the following directory structure:\n\n```shell\n├── about.md\n├── posts\n  ├── art-of-getting-better.md\n  ├── behavior-of-links-created-using-javascript.md\n  └── yellow-fade-technique-in-css.md\n├── site.json\n└── static\n    ├── resume.pdf\n    └── ebook.pdf\n```\n\n### About Page\n`about.md` is the markdown file containing the content for your about page.\n\n### Blog Posts\n`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\n\n```shell\n---\ntitle: Your Personal Blog on GitHub Pages\ndate: 2022-05-25\npermalink: /personal-blog-ghpages\n---\n\nContent for your bog post\n```\n\nWhere `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.\n\n### Site Configuration\n\n`site.json` contains the configuration to setup the blog. Given below is the sample JSON configuration.\n\n```json\n{\n  \"title\": \"Kamran Ahmed\",\n  \"subtitle\": \"Lead engineer at Zalando — tech guy with an entrepreneurial spirit and knack for getting things done\",\n  \"owner\": {\n    \"name\": \"Kamran Ahmed\",\n    \"email\": \"kamranahmed.se@gmail.com\"\n  },\n  \"social\": {\n    \"github\": \"kamranahmedse\",\n    \"medium\": \"kamranahmedse\",\n    \"twitter\": \"kamranahmedse\"\n  },\n  \"newsletter\": {\n    \"currentCount\": \"2,000\",\n    \"revueUsername\": \"roadmapsh\"\n  },\n  \"seo\": {\n    \"title\": \"Kamran Ahmed\",\n    \"description\": \"Blog of a Software Engineer\",\n    \"author\": \"Kamran Ahmed\",\n    \"keywords\": [\n      \"blog\",\n      \"developer blog\",\n      \"engineering blog\"\n    ]\n  },\n  \"cname\": \"kamranahmed.info\"\n}\n```\n\nFor 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.\n\n### Static Assets\n\nThe contents of the `static` folder will simply be copied at the root of your blog and will be accessible via `http://[blogurl]/filename`\n\n![](./.github/assets/split.png)\n\n## Setting Up GitHub Action\n\nOnce 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\n\n```yaml\nname: Build and Deploy\non: [push]\njobs:\n  build-and-deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n\n      - name: Deploy\n        uses: kamranahmedse/github-pages-blog-action@v0.0.10\n        with:\n          branch: gh-pages # Optional branch for GitHub Pages\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkamranahmedse%2Fgithub-pages-blog-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkamranahmedse%2Fgithub-pages-blog-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkamranahmedse%2Fgithub-pages-blog-action/lists"}