From 9f336b62866f4829f40e799e27e1d0abda2b6636 Mon Sep 17 00:00:00 2001 From: enscribe <jason@enscribe.dev> Date: Thu, 24 Oct 2024 23:16:33 -0700 Subject: [PATCH] chore(readme): add community examples table --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 42efa4e..eeeeee5 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,14 @@ astro-erudite is an opinionated, no-frills static blogging template built with [Astro](https://astro.build/), [Tailwind](https://tailwindcss.com/), and [shadcn/ui](https://ui.shadcn.com/). Extraordinarily loosely based off the [Astro Micro](https://astro-micro.vercel.app/) theme by [trevortylerlee](https://github.com/trevortylerlee). -To learn more about why this template exists, read [The State of Static Blogs in 2024](https://astro-erudite.vercel.app/blog/the-state-of-static-blogs), where I share my take on what constitutes a great blogging template and my goals while developing this one. +> [!NOTE] +> To learn more about why this template exists, read [The State of Static Blogs in 2024](https://astro-erudite.vercel.app/blog/the-state-of-static-blogs), where I share my take on what constitutes a great blogging template and my goals while developing this one. --- ## Technology Stack -This is a list of the various technologies used to build this website: +This is a list of the various technologies used to build this template: | Category | Technology Name | | ------------------- | -------------------------------------------------------------------------------------------------- | @@ -29,8 +30,6 @@ This is a list of the various technologies used to build this website: | Graphics | [Figma](https://www.figma.com/) | | Deployment | [Vercel](https://vercel.com) | ---- - ## Features - [Astro](https://astro.build/)’s [Islands](https://docs.astro.build/en/concepts/islands/) architecture for partial/selective hydration and client-side interactivity while maintaining a fast-to-render static site. @@ -43,6 +42,14 @@ This is a list of the various technologies used to build this website: - Supports author profiles (with a dedicated authors page) and adding multiple authors per post. - Supports project tags (with a dedicated tags page) for easy post categorization and discovery. +## Community Examples + +Below are some fantastic examples of websites based on this template. If you wish to add your site to this list, open a pull request! + +| Site | Author | Description/Features | Source | +|------|--------|-------------|--------| +| [enscribe.dev](https://enscribe.dev) | [@jktrn](https://github.com/jktrn) | Heavily modified bento-style homepage with client interactivity, with custom MDX components! | [→](https://github.com/jktrn/enscribe.dev) | + ## Getting Started 1. Hit “Use this template”, the big green button on the top right, to create a new repository in your own GitHub account with this template. @@ -201,7 +208,8 @@ The author schema is defined as follows: | `linkedin` | `string.url()` | Must be a valid URL. | Optional | | `discord` | `string.url()` | Must be a valid URL. | Optional | -You can add as many social media links as you want, as long as you adjust the schema! Make sure you also support the new field in the `src/components/SocialIcons.astro` component. +> [!TIP] +> You can add as many social media links as you want, as long as you adjust the schema! Make sure you also support the new field in the `src/components/SocialIcons.astro` component. ### Projects