{"id":15693190,"url":"https://github.com/code-hex/blog","last_synced_at":"2025-04-15T09:35:35.716Z","repository":{"id":71653101,"uuid":"594460678","full_name":"Code-Hex/blog","owner":"Code-Hex","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-08T04:47:26.000Z","size":1275,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T18:51:52.639Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://blog.codehex.dev","language":"Astro","has_issues":false,"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/Code-Hex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-28T16:15:10.000Z","updated_at":"2025-03-08T04:47:29.000Z","dependencies_parsed_at":"2023-11-25T11:31:29.431Z","dependency_job_id":"842276b1-86f7-4e24-826f-a207f8b048ce","html_url":"https://github.com/Code-Hex/blog","commit_stats":{"total_commits":84,"total_committers":2,"mean_commits":42.0,"dds":"0.11904761904761907","last_synced_commit":"e43c62ef6f3a735370fcf029d81874cfcfb0420d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Code-Hex%2Fblog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Code-Hex%2Fblog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Code-Hex%2Fblog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Code-Hex%2Fblog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Code-Hex","download_url":"https://codeload.github.com/Code-Hex/blog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249043475,"owners_count":21203467,"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":[],"created_at":"2024-10-03T18:42:06.470Z","updated_at":"2025-04-15T09:35:35.681Z","avatar_url":"https://github.com/Code-Hex.png","language":"Astro","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AstroPaper 📄\n\n![AstroPaper](public/astropaper-og.jpg)\n[![Figma](https://img.shields.io/badge/Figma-F24E1E?style=for-the-badge\u0026logo=figma\u0026logoColor=white)](https://www.figma.com/community/file/1356898632249991861)\n![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n![GitHub](https://img.shields.io/github/license/satnaing/astro-paper?color=%232F3741\u0026style=for-the-badge)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits\u0026logoColor=white\u0026style=for-the-badge)](https://conventionalcommits.org)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/)\n\nAstroPaper is a minimal, responsive, accessible and SEO-friendly Astro blog theme. This theme is designed and crafted based on [my personal blog](https://satnaing.dev/blog).\n\nThis theme follows best practices and provides accessibility out of the box. Light and dark mode are supported by default. Moreover, additional color schemes can also be configured.\n\nThis theme is self-documented \\_ which means articles/posts in this theme can also be considered as documentations. Read [the blog posts](https://astro-paper.pages.dev/posts/) or check [the README Documentation Section](#-documentation) for more info.\n\n## 🔥 Features\n\n- [x] type-safe markdown\n- [x] super fast performance\n- [x] accessible (Keyboard/VoiceOver)\n- [x] responsive (mobile ~ desktops)\n- [x] SEO-friendly\n- [x] light \u0026 dark mode\n- [x] fuzzy search\n- [x] draft posts \u0026 pagination\n- [x] sitemap \u0026 rss feed\n- [x] followed best practices\n- [x] highly customizable\n- [x] dynamic OG image generation for blog posts [#15](https://github.com/satnaing/astro-paper/pull/15) ([Blog Post](https://astro-paper.pages.dev/posts/dynamic-og-image-generation-in-astropaper-blog-posts/))\n\n_Note: I've tested screen-reader accessibility of AstroPaper using **VoiceOver** on Mac and **TalkBack** on Android. I couldn't test all other screen-readers out there. However, accessibility enhancements in AstroPaper should be working fine on others as well._\n\n## ✅ Lighthouse Score\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://pagespeed.web.dev/report?url=https%3A%2F%2Fastro-paper.pages.dev%2F\u0026form_factor=desktop\"\u003e\n    \u003cimg width=\"710\" alt=\"AstroPaper Lighthouse Score\" src=\"AstroPaper-lighthouse-score.svg\"\u003e\n  \u003ca\u003e\n\u003c/p\u003e\n\n## 🚀 Project Structure\n\nInside of AstroPaper, you'll see the following folders and files:\n\n```bash\n/\n├── public/\n│   ├── assets/\n│   │   └── logo.svg\n│   │   └── logo.png\n│   └── favicon.svg\n│   └── astropaper-og.jpg\n│   └── robots.txt\n│   └── toggle-theme.js\n├── src/\n│   ├── assets/\n│   │   └── socialIcons.ts\n│   ├── components/\n│   ├── content/\n│   │   |  blog/\n│   │   |    └── some-blog-posts.md\n│   │   └── config.ts\n│   ├── layouts/\n│   └── pages/\n│   └── styles/\n│   └── utils/\n│   └── config.ts\n│   └── types.ts\n└── package.json\n```\n\nAstro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.\n\nAny static assets, like images, can be placed in the `public/` directory.\n\nAll blog posts are stored in `src/content/blog` directory.\n\n## 📖 Documentation\n\nDocumentation can be read in two formats\\_ _markdown_ \u0026 _blog post_.\n\n- Configuration - [markdown](src/content/blog/how-to-configure-astropaper-theme.md) | [blog post](https://astro-paper.pages.dev/posts/how-to-configure-astropaper-theme/)\n- Add Posts - [markdown](src/content/blog/adding-new-post.md) | [blog post](https://astro-paper.pages.dev/posts/adding-new-posts-in-astropaper-theme/)\n- Customize Color Schemes - [markdown](src/content/blog/customizing-astropaper-theme-color-schemes.md) | [blog post](https://astro-paper.pages.dev/posts/customizing-astropaper-theme-color-schemes/)\n- Predefined Color Schemes - [markdown](src/content/blog/predefined-color-schemes.md) | [blog post](https://astro-paper.pages.dev/posts/predefined-color-schemes/)\n\n\u003e For AstroPaper v1, check out [this branch](https://github.com/satnaing/astro-paper/tree/astro-paper-v1) and this [live URL](https://astro-paper-v1.astro-paper.pages.dev/)\n\n## 💻 Tech Stack\n\n**Main Framework** - [Astro](https://astro.build/)  \n**Type Checking** - [TypeScript](https://www.typescriptlang.org/)  \n**Component Framework** - [ReactJS](https://reactjs.org/)  \n**Styling** - [TailwindCSS](https://tailwindcss.com/)  \n**UI/UX** - [Figma Design File](https://www.figma.com/community/file/1356898632249991861)  \n**Fuzzy Search** - [FuseJS](https://fusejs.io/)  \n**Icons** - [Boxicons](https://boxicons.com/) | [Tablers](https://tabler-icons.io/)  \n**Code Formatting** - [Prettier](https://prettier.io/)  \n**Deployment** - [Cloudflare Pages](https://pages.cloudflare.com/)  \n**Illustration in About Page** - [https://freesvgillustration.com](https://freesvgillustration.com/)  \n**Linting** - [ESLint](https://eslint.org)\n\n## 👨🏻‍💻 Running Locally\n\nYou can start using this project locally by running the following command in your desired directory:\n\n```bash\n# npm 6.x\nnpm create astro@latest --template satnaing/astro-paper\n\n# npm 7+, extra double-dash is needed:\nnpm create astro@latest -- --template satnaing/astro-paper\n\n# yarn\nyarn create astro --template satnaing/astro-paper\n\n# pnpm\npnpm dlx create-astro --template satnaing/astro-paper\n```\n\n\u003e **_Warning!_** If you're using `yarn 1`, you might need to [install `sharp`](https://sharp.pixelplumbing.com/install) as a dependency.\n\u003e Then start the project by running the following commands:\n\n```bash\n# install dependencies\nnpm run install\n\n# start running the project\nnpm run dev\n```\n\n## Google Site Verification (optional)\n\nYou can easily add your [Google Site Verification HTML tag](https://support.google.com/webmasters/answer/9008080#meta_tag_verification\u0026zippy=%2Chtml-tag) in AstroPaper using environment variable. This step is optional. If you don't add the following env variable, the google-site-verification tag won't appear in the html `\u003chead\u003e` section.\n\n```bash\n# in your environment variable file (.env)\nPUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-value\n```\n\n## 🧞 Commands\n\nAll commands are run from the root of the project, from a terminal:\n\n\u003e **_Note!_** For `Docker` commands we must have it [installed](https://docs.docker.com/engine/install/) in your machine.\n\n| Command                              | Action                                                                                                                           |\n| :----------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- |\n| `npm install`                        | Installs dependencies                                                                                                            |\n| `npm run dev`                        | Starts local dev server at `localhost:4321`                                                                                      |\n| `npm run build`                      | Build your production site to `./dist/`                                                                                          |\n| `npm run preview`                    | Preview your build locally, before deploying                                                                                     |\n| `npm run format:check`               | Check code format with Prettier                                                                                                  |\n| `npm run format`                     | Format codes with Prettier                                                                                                       |\n| `npm run sync`                       | Generates TypeScript types for all Astro modules. [Learn more](https://docs.astro.build/en/reference/cli-reference/#astro-sync). |\n| `npm run lint`                       | Lint with ESLint                                                                                                                 |\n| `docker compose up -d`               | Run AstroPaper on docker, You can access with the same hostname and port informed on `dev` command.                              |\n| `docker compose run app npm install` | You can run any command above into the docker container.                                                                         |\n\n\u003e **_Warning!_** Windows PowerShell users may need to install the [concurrently package](https://www.npmjs.com/package/concurrently) if they want to [run diagnostics](https://docs.astro.build/en/reference/cli-reference/#astro-check) during development (`astro check --watch \u0026 astro dev`). For more info, see [this issue](https://github.com/satnaing/astro-paper/issues/113).\n\n## ✨ Feedback \u0026 Suggestions\n\nIf you have any suggestions/feedback, you can contact me via [my email](mailto:contact@satnaing.dev). Alternatively, feel free to open an issue if you find bugs or want to request new features.\n\n## 📜 License\n\nLicensed under the MIT License, Copyright © 2025\n\n---\n\nMade with 🤍 by [Sat Naing](https://satnaing.dev) 👨🏻‍💻 and [contributors](https://github.com/satnaing/astro-paper/graphs/contributors).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-hex%2Fblog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-hex%2Fblog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-hex%2Fblog/lists"}