blog/README.md
2024-12-10 17:20:48 +01:00

51 lines
3 KiB
Markdown

# 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-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 eleventy pages |
| `eleventy-plugin-embed-everything` | Embeds YouTube, Soundcloud, Spotify, Instagram, etc. |
| `eleventy-plugin-icons` | Plugin to use various icon sets in templates |
| `eleventy-plugin-metagen` | Generates `<meta>` 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 `<abbr>` tags |
| `markdown-it-anchor` | Adds anchor tag IDs to headings |
| `markdown-it-collapsible` | Extends Markdown with syntax for `<details>` and `<summary>` |
| `markdown-it-deflist` | Extends Markdown with syntax for `<dl>`, `<dt>` and `<dd>` |
| `markdown-it-footnote` | Extends Markdown with syntax for footnotes |
| `markdown-it-image-figures` | Extends Markdown with syntax for `<figure>` and `<figcaption>` |
| `markdown-it-obsidian-callouts` | Extends Markdown with syntax for footnotes Obsidian style callouts |
| `simple-icons` | Simple Icons icon pack for use with `eleventy-plugin-icons` |