docs: 📝 add README

2024-10-12 23:11:27 +02:00 · 2024-10-12 23:11:27 +02:00 · 73e55e84b4
commit 73e55e84b4
parent b3003321c9
1 changed files with 47 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,47 @@
+# Sebin's Blog
+
+This is the template for [Sebin's Blog](https://blog.sebin-nyshkim.net), built with the [11ty](https://www.11ty.dev) static site generator.
+
+## Get up and running
+
+First, install all the packages with `npm`:
+
+```bash
+npm install
+```
+
+To start serving locally:
+
+```bash
+npm start
+```
+
+To build the site for deployment:
+
+```bash
+npm build
+```
+
+## Plugins
+
+This template uses the following plugins to extend the capabilities and features of 11ty:
+
+| Package                                  | Description                                              |
+|------------------------------------------|----------------------------------------------------------|
+| `@11ty/eleventy` (`IdAttributePlugin`)   | Adds an `id` to headings for anchor links                |
+| `@11ty/eleventy-img`                     | Automated image processing and conversion                |
+| `@11ty/eleventy-navigation`              | Generate navigation from collections                     |
+| `@11ty/eleventy-plugin-rss`              | Generates RSS or Atom XML feeds for news readers         |
+| `@11ty/eleventy-plugin-syntaxhighlight`  | Syntax highlighting for code blocks                      |
+| `@alexcarpenter/eleventy-plugin-caniuse` | Can I Use feature embeds                                 |
+| `@grimlink/eleventy-plugin-lucide-icons` | Lucide icon shortcodes                                   |
+| `@myxotod/eleventy-plugin-readingtime`   | Adds an estimated reading time to posts                  |
+| `@quasibit/eleventy-plugin-sitemap`      | Generates a `sitemap.xml` from collections               |
+| `eleventy-plugin-embed-everything`       | Embeds YouTube, Soundcloud, Spotify, Instagram, etc.     |
+| `eleventy-plugin-metagen`                | Generates ` ` tags for social media embeds               |
+| `eleventy-plugin-og-image`               | Generates OpenGraph images for social media sharing      |
+| `eleventy-plugin-robotstxt`              | Generates a `robots.txt` for the site                    |
+| `markdown-it-abbr`                       | Extends Markdown with syntax for `` tags                 |
+| `markdown-it-collapsible`                | Extends Markdown with syntax for ` ` and ` ` tags        |
+| `markdown-it-footnote`                   | Extends Markdown with syntax for footnotes               |
+| `markdown-it-obsidian-callouts`          | Extends Markdown with syntax for Obsidian style callouts |