You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* feat: add initial configuration and social icons for AstroPaper theme
* feat: add theme styles and design tokens
* chore: configure Astro with sitemap, i18n, fonts, and tooling
- Set site URL, i18n (single locale, no prefix), sitemap integration
- Add Google Sans Code font via stable fonts API
- Configure Shiki dual-theme markdown (min-light / night-owl)
- Fix astro-paper.config.ts to use relative import (alias not
available when Vite loads root-level config files)
- Add @astrojs/sitemap and @typescript-eslint/parser dependencies
- Wire @typescript-eslint/parser into ESLint so TypeScript syntax
in Astro frontmatter (type Props, etc.) parses correctly
* feat: add base styles, dark variant, and typography
- global.css: dark variant via [data-theme], base layer for * / a /
button selectors, scrollbar tokens, layout utilities (max-w-app,
app-layout), active-nav as @Utility for Tailwind variant support
- html and body classes moved directly onto elements in BaseLayout
(Tailwind-native approach) so only truly global selectors remain here
- typography.css: prose overrides, Shiki light/dark code block
switching, diff/highlight/word-highlight transformer styles
* feat: add i18n types, English strings, and useTranslations helper
Plain typed object approach — no third-party i18n library needed.
Paraglide.js was considered but requires SSR output (hard blocker
for a static Astro site).
- UIStrings interface with nav, post, pagination, and a11y groups
- en.ts with `satisfies UIStrings` for literal-type preservation
- useTranslations(locale) helper falls back to English automatically
Adding a new language is a one-file addition; full routing stays
as a registry add-on.
* feat: add client-side theme toggle script
- Reads window.__theme.value set by the inline FOUC-prevention script
to avoid re-detecting the theme on first load
- Toggles data-theme on <html> and persists to localStorage
- Fills <meta name="theme-color"> with the computed background colour
so Android's browser chrome matches the page
- Re-runs setup on astro:after-swap for View Transitions navigation
- Carries theme-color across astro:before-swap to prevent navbar
flicker on Android during page transitions
- Syncs with OS prefers-color-scheme changes at runtime
* feat: add BaseLayout and PostLayout
BaseLayout (replaces scaffold Layout.astro):
- Font, canonical URL via Astro.site, RSS autodiscovery
- FOUC-prevention inline script sets data-theme before first paint
and exposes window.__theme.value for theme.ts to reuse
- html/body classes on elements directly (Tailwind-native)
- <slot name="head"> for child layout injection
- ClientRouter for View Transitions (respects lightAndDarkMode flag)
- googleVerification rendered from config instead of .env — it is a
public string, not a secret, and not environment-specific
PostLayout (new):
- Wraps BaseLayout; injects article-specific head content via slot
- Overrides og:type to "article"
- Adds article:published_time / article:modified_time conditionally
- JSON-LD BlogPosting with conditional datePublished/dateModified
(fixes old bug where absent dates produced "undefined" string)
- Structured data only on actual post pages (not home/archives/tags)
SiteConfig: add optional googleVerification field
* chore: replace scaffold index page with BaseLayout placeholder
* feat: add Header component
* feat: add Footer and Socials component
* chore: install dayjs, slugify, zod, @astrojs/mdx and add MDX integration
* feat: add resolved config that applies defaults in one place
Defaults for posts, features, socials, and shareLinks are merged in
src/config.ts so all consuming code gets non-optional types with no
scattered ?? fallbacks.
* feat: add content schema, blog path, and post utilities
Renames collection blog→posts, moves content to src/content/posts/,
adds .mdx support, and adds a typed pages collection. Includes
getSortedPosts, postFilter, getPath, and slugify utilities.
* feat: add Datetime and Card components
* refactor: switch layouts and components to resolved config
Replaces @/astro-paper.config imports with @/config and removes
optional chaining on feature flags now that the resolved config
guarantees non-optional values.
* feat: add home and footer i18n strings
* feat: implement home page with hero, featured, and recent posts
Replaces the BaseLayout placeholder with the full index page:
hero section with RSS link and social links, featured posts section,
recent posts capped at posts.perIndex, and an All Posts link. All
section labels come from i18n.
* feat: add pagination component
* feat: add Breadcrumb component with locale support
* feat: add Main component
* refactor: update code formatting in Card.astro
* feat: add posts page
* fix: add missing @astrojs/mdx dependency
* refactor: rename meta to pages in i18n
* refactor: improve code formatting in Breadcrumb
* refactor: destructure props in Main component for clarity
* feat: add tag pages
* feat: add About page
* chore: update i18n configuration to use site language from config
* feat: add Archives page
* feat: integrate Pagefind search functionality
* feat: add dynamic Open Graph image generation for posts
* feat: add post detail page
* feat: add Shiki transformers
* chore: remove unused edit link text
* chore: update .gitignore to include generated Pagefind directory
* chore: update site URL in configuration to production link
* chore: replace favicon and remove unused SVG assets, add new Open Graph image
* feat: update site config with default values
* feat: add default OG image path resolution
* fix: ensure edit post feature checks for enabled status correctly
* feat: implement dynamic Open Graph image generation
* feat: add RSS feed generation functionality
* feat: add 404 Not Found page
* feat: add robots.txt generation for SEO optimization
* refactor: change getSortedPosts to a named export
* refactor: change postFilter to a named export
* refactor: rename BaseLayout to Layout
* refactor: standardize locale handling across components
* refactor: update getPostsByGroupCondition location
* chore: remove unused Welcome component
* refactor(i18n): update links using getRelativeLocaleUrl
* refactor(i18n): add dynamic locale loading
* fix: update language attribute to use current locale
* fix: correct wording for updatedAt in post translations
* fix: update layout titles to use correct translation keys for tags pages
* chore: use new colors for better DX and a11y
* feat: add underline icon for active icon nav
* feat: add toc for markdown contents
* refactor: remove unused feature flags in config
* refactor(i18n): enhance locale handling and path management
* fix: ts unused variable hint
* refactor: extract locale stripping logic into a util func
* refactor(i18n): improve locale handling in tag pages
* refactor: update post URL helper functions
* refactor(i18n): replace pathWithBase with getRelativeLocaleUrl for locale handling
* refactor: rename fileWithBase to getAssetPath
* refactor: use runtime agnostic APIs for file paths
* refactor: use transition directive for heading transition
* refactor: remove unused title element from tag page
* fix: decouple ClientRouter from lightAndDarkMode flag
* refactor: rename `postPaths.ts` to `getPostPaths.ts`
* refactor: remove unused `minutesRead` string from post translations
* refactor: simplify AdjacentPostNav component by passing prevPost and nextPost directly
* refactor: remove unused code declaration
* docs: add existing blog posts
* chore: update astro and @astrojs/check dependencies to latest versions
* build: use experimental svg optimizer
* chore(repo): restore project meta files and Docker configs
* refactor: update code formatting with Prettier
* docs: update README and docs
* docs: add JSDoc comments to utility functions
* docs: add JSDoc comments to resolved config file
* fix(og): avoid double slashes when appending index.png
* chore(ci): update Node.js version to 22.12.0 in CI workflow
* feat: improve og image generation with Astro's getFontFileURL API (#632)
* feat: improve og image generation with Astro's getFontFileURL API
- remove @resvg/resvg-js and use sharp to convert SVG to PNG
- update og image generation to use Astro's getFontFileURL API for better font handling
* docs: update README and dynamic OG images documentation
- remove outdated content and clarify dynamic OG image generation process in README.
- add new image example and update instructions for handling non-Latin characters in dynamic OG images.
- adjust copyright year in README to 2026.
* fix(header): adjust icon button alignment in mobile
* feat(docs): add ResponsiveTable to use it in MDX posts (#634)
* feat(docs): add ResponsiveTable to use it in MDX posts
Introduce ResponsiveTable with variant-based styling. Rename docs posts to
.mdx, wrap tables in the component, and remove redundant table `code` rules
from prose typography.
* chore(prettier): ignore .mdx files when checking format
* chore(ci): update Node.js version to 24 in CI workflow
* bump: upgrade Astro and dependencies
* fix: remove redundant backUrl script bug
* fix(header): adjust button and icon alignment
* fix(a11y): improve muted-foreground color contrast
* docs: update predefined color schemes
* chore: support site verification env as fallback for googleVerification
* docs: add astro paper v6 updates in docs
* docs: add AstroPaper-v6.png in astro-paper-6 blog post
* fix: update back-to-top button DOM placement (#641)
Closes#626, #131, #493
-[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/))
29
+
-[x] dynamic OG image generation for blog posts ([Blog Post](https://astro-paper.pages.dev/posts/dynamic-og-image-generation-in-astropaper-blog-posts/))
30
+
-[x] i18n ready
28
31
29
32
_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._
30
33
@@ -43,57 +46,55 @@ Inside of AstroPaper, you'll see the following folders and files:
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
71
-
72
-
Any static assets, like images, can be placed in the `public/` directory.
73
-
74
-
All blog posts are stored in `src/data/blog` directory.
75
+
All blog posts are stored in the `src/content/posts/` directory. You can organise posts into subdirectories — the subdirectory name becomes part of the post URL.
75
76
76
77
## 📖 Documentation
77
78
78
79
Documentation can be read in two formats\__markdown_ & _blog post_.
**Illustration in About Page** - [https://freesvgillustration.com](https://freesvgillustration.com/)
96
-
**Linting** - [ESLint](https://eslint.org)
96
+
**Linting** - [ESLint](https://eslint.org)
97
+
**Dynamic OG images** - [Satori](https://github.com/vercel/satori) + [Sharp](https://sharp.pixelplumbing.com/) + [Astro Fonts](https://docs.astro.build/en/guides/fonts/)
97
98
98
99
## 👨🏻💻 Running Locally
99
100
@@ -120,26 +121,21 @@ Then start the project by running the following commands:
120
121
pnpm install
121
122
122
123
# start running the project
123
-
pnpm run dev
124
-
```
125
-
126
-
As an alternative approach, if you have Docker installed, you can use Docker to run this project locally. Here's how:
127
-
128
-
```bash
129
-
# Build the Docker image
130
-
docker build -t astropaper .
131
-
132
-
# Run the Docker container
133
-
docker run -p 4321:80 astropaper
124
+
pnpm dev
134
125
```
135
126
136
127
## Google Site Verification (optional)
137
128
138
-
You can easily add your [Google Site Verification HTML tag](https://support.google.com/webmasters/answer/9008080#meta_tag_verification&zippy=%2Chtml-tag)in AstroPaper using an environment variable. This step is optional. If you don't add the following environment variable, the google-site-verification tag won't appear in the HTML `<head>` section.
129
+
You can add your [Google Site Verification HTML tag](https://support.google.com/webmasters/answer/9008080#meta_tag_verification&zippy=%2Chtml-tag)by setting `site.googleVerification`in `astro-paper.config.ts`:
> See [this discussion](https://github.com/satnaing/astro-paper/discussions/334#discussioncomment-10139247) for adding AstroPaper to the Google Search Console.
|`docker run -p 4321:80 astropaper`| Run AstroPaper on Docker. The website will be accessible at `http://localhost:4321`. |
167
-
168
-
> **_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 & astro dev`). For more info, see [this issue](https://github.com/satnaing/astro-paper/issues/113).
|`pnpm dev`| Starts local dev server at `localhost:4321`|
151
+
|`pnpm build`| Type-checks, builds the site, runs Pagefind indexing, and copies the index to `public/pagefind/`|
152
+
|`pnpm preview`| Preview your build locally, before deploying |
153
+
|`pnpm sync`| Generates TypeScript types for all Astro modules. [Learn more](https://docs.astro.build/en/reference/cli-reference/#astro-sync). |
154
+
|`pnpm astro ...`| Run CLI commands like `astro add`, `astro check`|
169
155
170
156
## ✨ Feedback & Suggestions
171
157
172
-
If 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.
158
+
If you have any suggestions/feedback, you can contact me via [my email](mailto:satnaingdev+astropaper@gmail.com). Alternatively, feel free to open an issue if you find bugs or want to request new features.
0 commit comments