kokitree / blog-template

📚 Openblog is an elegant, simple, and user-friendly blog. Focused on accessibility, SEO, and performance.

---

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

✅ Lighthouse Score

🔤 Readme Translations

• English
• Español

💻 Demo

Check out the Demo, hosted on Vercel

demo.mp4

⚙️ Stack

• ASTRO + Typescript - Astro is the all-in-one web framework designed for speed.
• Tailwind CSS + Tailwind-Merge + clsx - Tailwind CSS is a utility-first CSS framework.
• Tabler Icons - A open source SVG icons.
• Eslint - ESLint is an open source project that helps you find and fix problems.
• Prettier - Code formatter.
• Search Library - Static search library integration.
• Motion - Motion One is the smallest fully-featured animation library for the web.

💪 Features:

• ✅ Minimal styling
• ✅ Mobile responsive
• ✅ 100/100 Lighthouse performance
• ✅ SEO-friendly with canonical URLs and OpenGraph data
• ✅ Sitemap support
• ✅ RSS Feed support
• ✅ Markdown & MDX support
• ✅ Syntax highlighting
• ✅ Image optimization
• ✅ Table of contents
• ✅ Dark mode
• ✅ Reading Time
• ✅ Pagefind static search library integration
• ✅ Related posts
• ✅ Share posts (Linkedin, twitter)
• ✅ Draft mode (new)
• ✅ Copy code block (new)

🛣️ Roadmap

• ❌ Add post author
• ❌ Add customization with colors
• ❌ Add Pagination
• ❌ Add filters for reading time, date...
• ❌ Improve design of the navigation bar and footer
• ❌ More sharing options
• ❌ Internationalization (i18n)

👨🏻‍💻 Running Locally

Recommended extensions for VSCode:

• Tailwind CSS IntelliSense.
• Astro.

1. Clone or fork the repository:

[email protected]:danielcgilibert/blog-template.git

2. Install dependencies:

pnpm install

3. Run the development server:

pnpm dev

📐 Configure

• Edit the configuration file src/data/site.config.ts for the basic blog 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 blog link. For posts, the preview image is the post cover.
• Edit the social networks in the Header component - src/components/Header.astro, change the URL to your social network.

🗂️ Adding a category

To add a new category to your blog, simply go to the src/data/categories.ts file and add it to the array.

Example:

export  const  CATEGORIES  =  [
'JavaScript',
'React',
'new category here'  <---
]  as  const

🚨 Zod checks whether the category is not correctly written or does not exist in the properties of the markdown document. It will throw an error when building the application. 🚨

📄 Adding a post

Adding a post is as simple as adding a .md or .mdx file to the blog folder at the path src/content/blog. 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 blog.

Example :

title: MacBook Pro 2022
description: 'The new MacBook Pro 2022 is here. With the Apple M2 chip, a new design, and more, the new MacBook Pro is the best laptop Apple has ever made.'
pubDate: 'Jul 02 2022'
heroImage: '../../assets/bg.jpg'
category: 'Category 1'
tags: ['JavaScript', 'css', 'HTML5', 'GitHub']
draft: true <---

⚡️ Frontmatter

Required properties:

• Title
• Description
• pubDate
• heroImage (post cover)
• category (Choose a category from src/data/categories.ts)

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 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 sync	Generates TypeScript types for all Astro modules. Learn more.
pnpm run lint	Lint with ESLint

👋 Contributors