⭐ Leave a star if you like this project! ⭐️

Check out the Demo

---

📌 Table Of Contents

• Features
• Roadmap
• Stack
• Running locally
• Configure
• Categories
• Posts
• Draft
• FrontMatter
• CMS
• CLI
• Contributors

💪 Features:

• ✅ Markdown & MDX support
• ✅ Resume page to show off skills, experience, education, etc.
• ✅ Semantic HTML
• ✅ Image optimization
• ✅ Mobile responsive
• ✅ SEO-friendly with canonical URLs and OpenGraph data
• ✅ Sitemap support
• ✅ RSS Feed support
• ✅ Pagefind static search library integration

Posts

• ✅ Zero-database commenting
• ✅ Related posts
• ✅ Table of contents
• ✅ Draft mode
• ✅ Code blocks with syntax highlighting
• ✅ Share to Linkedin, twitter, dev.to, and easily add more
• ✅ CMS

⚙️ Stack

• TypeScript
• Astro - Astro is the all-in-one web framework designed for speed.
• Tailwind CSS + Tailwind-Merge + clsx - Tailwind CSS is a utility-first CSS framework.
• Iconify - Super-easy integration of all popular icon sets.
• Eslint - Linter and code formatting rules.
• Search Library - Static search library integration.
• Motion - Motion One is the smallest fully-featured animation library for the web.
• Giscus - Disqus-style comments powered by GitHub discussions for a zero-database comment section that you control.
• Tina - CMS.

👨🏻‍💻 Running Locally

Recommended extensions for VSCode:

• Tailwind CSS IntelliSense.
• Astro.

1. Clone or fork the repository:

[email protected]:jetboom/personal-site.git

2. Install dependencies:

pnpm install

3. Run the development server:

pnpm start

📐 Configure

• Edit the configuration file src/site.config.ts for the basic site metadata.
• Update the astro.config.mjs file at the root of the project with your own domain.
• Modify the files in the /public folder:
  • favicon
  • robots.txt -> update the Sitemap url to your own domain
  • open-graph -> the open-graph is the image that will be displayed when sharing the site link. For posts, the preview image is the post cover.

📄 Adding a post

Adding a post is as simple as adding a .md or .mdx file to the posts folder at the path src/content/posts. The filename will be used to create the slug/URL of the page.

For example, if you have a file named jsx-and-react.md, it will be transformed into: http://yourdomain.com/post/jsx-and-react/

📝 Activating draft mode

To activate draft mode, add the property draft: true to the file, and it will no longer be displayed on the post.

⚡️ Frontmatter

Required properties:

• Title
• Description
• pubDate
• image (post cover)
• category

🦙 Tina CMS

By default, this template comes pre-configured with Tina CMS.

Now you can create your posts directly from the CMS without the need to do it manually.

If you decide to use Tina, it's not necessary to add any properties to the Markdown files, Tina does it automatically.

The documentation for Tina CMS can be found here

Tina is completely optional, and you can remove it, and it will still function in the same way.

Optional properties:

• draft (no need to include it, by default it's false)
• tags

The schema for posts is located at src/content/config.ts. You can modify any parameter, for example, by adding a maximum of 80 characters for titles: title: z.string().max(80). For more information, refer to the zod documentation.

🧞 Commands

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

Command	Action
pnpm install	Installs dependencies
pnpm start	Starts local dev server at localhost:4321
pnpm build	Build your production site to ./dist/
astro sync	Generates TypeScript types for all Astro modules. Learn more.
pnpm run lint	Lint with ESLint

👋 Contributors