PahazBlog 📄

PahazBlog is a minimal, responsive, accessible and SEO-friendly Astro blog theme. This theme is designed and crafted based on pahaz personal blog.

🔥 Features

• type-safe markdown
• super fast performance
• accessible (Keyboard/VoiceOver)
• responsive (mobile ~ desktops)
• SEO-friendly
• light & dark mode
• fuzzy search
• draft posts & pagination
• sitemap & rss feed
• followed best practices
• highly customizable
• dynamic OG image generation

✅ Lighthouse Score

🚀 Project Structure

Inside of AstroPaper, you'll see the following folders and files:

/
├── public/
│   └── favicon.svg
│   └── astropaper-og.jpg
│   └── toggle-theme.js
├── src/
│   ├── assets/
│   │   └── socialIcons.ts
│   ├── components/
│   ├── content/
│   │   |  blog/
│   │   |    └── some-blog-posts.md
│   │   └── config.ts
│   ├── layouts/
│   └── pages/
│   └── styles/
│   └── utils/
│   └── config.ts
│   └── types.ts
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

Any static assets, like images, can be placed in the src/assets/ directory.

All blog posts are stored in src/content/blog directory.

📖 Documentation

Documentation can be read in two formats_ markdown & blog post.

• Configuration - blog post
• Add Posts - blog post
• Customize Color Schemes - blog post
• Predefined Color Schemes - blog post

💻 Tech Stack

Main Framework - Astro
Type Checking - TypeScript
Component Framework - ReactJS
Styling - TailwindCSS
UI/UX - Figma
Fuzzy Search - FuseJS
Icons - Boxicons | Tablers
Code Formatting - Prettier
Deployment - Github Pages
Illustration in About Page - https://freesvgillustration.com
Linting - ESLint

👨🏻‍💻 Running Locally

The easiest way to run this project locally is to run the following command in your desired directory.

# npm 6.x
npm create astro@latest --template satnaing/astro-paper

# npm 7+, extra double-dash is needed:
npm create astro@latest -- --template satnaing/astro-paper

# yarn
yarn create astro --template satnaing/astro-paper

🧞 Commands

All commands are run from the root of the project, from a terminal:

Note! For Docker commands we must have it installed in your machine.

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:4321
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run format:check	Check code format with Prettier
npm run format	Format codes with Prettier
npm run sync	Generates TypeScript types for all Astro modules. Learn more.
npm run cz	Commit code changes with commitizen
npm run lint	Lint with ESLint
docker compose up -d	Run AstroPaper on docker, You can access with the same hostname and port informed on dev command.
docker compose run app npm install	You can run any command above into the docker container.

Warning! Windows PowerShell users may need to install the concurrently package if they want to run diagnostics during development (astro check --watch & astro dev). For more info, see this issue.

✨ Feedback & Suggestions

If you have any suggestions/feedback, leave an issue

📜 License

Licensed under the MIT License, Copyright © 2024

---

Based on AstroPaper and modified by Pahaz