astro-theme-facile is a minimal, responsive, accessible and SEO-friendly Astro blog theme. This theme is designed and crafted based on my personal blog.
This 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.
This theme is self-documented _ which means articles/blogs in this theme can also be considered as documentations. Read the blog posts or check the README Documentation Section for more info.
- 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 for blog posts (Blog Post)
Inside of astro-theme-facile, you'll see the following folders and files:
/
├── public/
│ ├── assets/
│ │ └── logo.svg
│ │ └── logo.png
│ └── favicon.svg
│ └── astro-theme-facile-og.jpg
│ └── robots.txt
├── src/
│ ├── assets/
│ │ └── socialIcons.ts
│ ├── components/
│ ├── contents/
│ │ └── some-blog-posts.md
│ ├── layouts/
│ └── pages/
│ └── styles/
│ └── utils/
│ └── config.ts
│ └── types.ts
└── package.jsonAstro 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 public/ directory.
All blog posts are stored in src/contents/ directory.
Documentation can be read in two formats_ markdown & blog post.
- Configuration - markdown | blog post
- Add Posts - markdown | blog post
- Customize Color Schemes - markdown | blog post
- Predefined Color Schemes - markdown | blog post
Main Framework - Astro
Type Checking - TypeScript
Component Framework - ReactJS
Styling - TailwindCSS
UI/UX - Figma
Fuzzy Search - FuseJS
Icons - Boxicons | Tablers
Code Formatting - Prettier
Deployment - Cloudflare Pages
Illustration in About Page - https://freesvgillustration.com
The easiest way to run this project locally is to run the following command in your desired directory.
# pnpm 6.x
pnpm create astro@latest --template zhanglun/astro-theme-facile
# pnpm 7+, extra double-dash is needed:
pnpm create astro@latest -- --template zhanglun/astro-theme-facile
# yarn
yarn create astro --template zhanglun/astro-theme-facileYou can easily add your Google Site Verification HTML tag in astro-theme-facile 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 <head> section.
# in your environment variable file (.env)
PUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-valueAll commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install |
Installs dependencies |
pnpm run dev |
Starts local dev server at localhost:3000 |
pnpm run build |
Build your production site to ./dist/ |
pnpm run preview |
Preview your build locally, before deploying |
pnpm run format:check |
Check code format with Prettier |
pnpm run format |
Format codes with Prettier |
pnpm run cz |
Commit code changes with commitizen |
pnpm run astro ... |
Run CLI commands like astro add, astro preview |
pnpm run astro --help |
Get help using the Astro CLI |
If you have any suggestions/feedback, feel free to open an issue if you find bugs or want to request new features.
Licensed under the MIT License, Copyright © 2023
Made with 🤍 by zhanglun 👨🏻💻
Thanks Sat Naing