Skip to content

stelcodes/multiterm-astro

Repository files navigation

MultiTerm Astro 🎨⚡️

MultiTerm is an Astro blog theme designed for coders who love their color schemes. Easily theme your whole website with your favorite color schemes and have your prose rendered with a nod to the aesthetics of raw markdown.

Check out the Showing Off Blog Features post to see all the exciting MultiTerm capabilites on the live example site!

v2.0.0 has been released! 🥳

Example website screenshot Example website screenshot Example website screenshot Example website screenshot Example website screenshot Example website screenshot Example autogenerated social card

✨ Features

  • Amazing Theme Selection: Personalize your blog's appearance with your favorite editor color scheme. Pick your favorite Shiki themes bundled with Expressive Code.
  • Dark/Light/Auto Theme Mode: Choose any two Shiki themes and use the standard light/dark/auto model for automatically adapting to your reader's theme preferences with button in the site header.
  • Multiple Theme Mode: Choose three (or all 59!) Shiki themes and allow your reader to choose their favorite from a dialog menu opened from a button in the header. Every element seamlessly changes color interactively using the magic of CSS variables.
  • GitHub Comment Section: Allow readers to respond, discuss, and react with a comment section powered by GitHub and Giscus. Painstakingly themed to match your site perfectly.
  • GitHub Activity Widget: Optionally include a statically generated GitHub activity calendar on the homepage that (of course) matches the active color scheme perfectly.
  • Markdown Extensions: Admonitions, auto-generated TOC that sticks to the side on large screens, emoji shortcodes, KaTeX math, MDX, and reading time estimates. See the example site's Showing Off Blog Features post.
  • RSS Feed and Sitemap: Built-in support for RSS feeds and sitemap with no extra configuration.
  • Social Links: Easily include links to common developer platforms including GitHub, Mastodon, Twitter, LinkedIn and E-mail.
  • Responsive Design: Optimized for all devices from desktops to mobile phones. Built with Tailwind v4.
  • SEO Optimized: Boost your site's visibility with built-in SEO best practices and automatically generated social card images for every page via Satori.
  • Customizable Build: Powered by Astro, render as a static site (the default) or generate content dynamically.

Check out the example site PageSpeed scores and OpenGraph analysis

🚀 Getting Started

Clone the Repository:

git clone --depth 1 https://github.com/stelcodes/multiterm-astro my-new-blog && cd my-new-blog

Install Dependencies:

npm install

Start the Development Server:

npm run dev

Build Your Site and View the Results:

npm run build && npm run preview

🛠️ Configuration

Simple configuration is a core feature of MultiTerm. All configuration is done from a single file: src/site.config.ts. This is where you can tailor your website to match your vision.

Please take a look at src/site.config.ts for more information about the configuration options.

To add your own content, check out the src/content directory. Feel free to remove all the example content and replace it with your own!

📄 License

This project is licensed under the MIT License.

Inspiration

🩷 Sponsor

Consider buying me a coffee to keep me caffeinated while I work on open source projects like this one!

Star History Chart

About

A coder-ready Astro blog theme with 60 of your favorite color schemes to choose from 🎨⚡️

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •