Skip to content

Latest commit

 

History

History
118 lines (88 loc) · 4.87 KB

README.md

File metadata and controls

118 lines (88 loc) · 4.87 KB
Screenshot

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

Deploy with Vercel Deploy to Netlify

✅ Lighthouse Score

openblog Lighthouse Score

🔤 Readme Translations

💻 Demo

Check out the Demo, hosted on Vercel
Screenshot

⚙️ Stack

💪 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)

🛣️ Roadmap

  • ❌ Copy code block
  • ❌ Draft mode
  • ❌ 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:

  1. Clone or fork the repository:
[email protected]:danielcgilibert/blog-template.git
  1. Install dependencies:
pnpm install
  1. Run the development server:
pnpm dev

🧞 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