smirky 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -64
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,17 @@
|
|
|
1
1
|
# Smirky — Minimalist Static Website Generator
|
|
2
2
|
|
|
3
|
+
|
|
4
|
+
I am a big fan of using the classic text editor VIM and using Markdown for writing plain text for technical writing
|
|
5
|
+
but using some of the static website generators out there I found them to be unnecessarily overly complicated
|
|
6
|
+
I just wanted a simple way for taking markdown files and coverting that content into a static website a.k.a made of just normal HTML pages.
|
|
7
|
+
Just like HTML is so simple for creating a web document, markdown is so simple for creating the content from plain text
|
|
8
|
+
and i didnt want to spend time fighting with the static website generator itself, creating themes and trying to figure out. What does what,and where verthing lives.
|
|
9
|
+
Most Static website generators haave too many damm features, and config files I need to wrestle with. Too that ened. Thats why I created Smirky
|
|
10
|
+
|
|
3
11
|
Smirky is a minimalist static website generator for people who just want to write Markdown and get a website — no ceremony, no plugins, no magic.
|
|
4
12
|
|
|
5
|
-
It is perfect for building blogs, landing pages, or any static site quickly.
|
|
13
|
+
It is perfect for building blogs, landing pages, or any static site quickly.Its open source you can download the code and improve on it. Creating a static website from markdown should not be rocket science.
|
|
14
|
+
Smirky keeps with the Kiss principle. Keep It Simple Stupid!
|
|
6
15
|
|
|
7
16
|
---
|
|
8
17
|
|
|
@@ -42,7 +51,7 @@ npm install -g smirky
|
|
|
42
51
|
npm install --save-dev smirky
|
|
43
52
|
```
|
|
44
53
|
|
|
45
|
-
2.
|
|
54
|
+
2. Your project structure looks like this:
|
|
46
55
|
|
|
47
56
|
```
|
|
48
57
|
my-site/
|
|
@@ -52,47 +61,6 @@ my-site/
|
|
|
52
61
|
└── package.json
|
|
53
62
|
```
|
|
54
63
|
|
|
55
|
-
3. Add your pages to `pages/` and your blog posts to `content/`:
|
|
56
|
-
|
|
57
|
-
**Example page**: `pages/about.md`
|
|
58
|
-
|
|
59
|
-
```md
|
|
60
|
-
---
|
|
61
|
-
title: About
|
|
62
|
-
slug: about
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
## About Smirky
|
|
66
|
-
|
|
67
|
-
Smirky is a minimalist static site generator. Write Markdown, run Smirky, done.
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
**Example blog post with tags**: `content/my-first-post.md`
|
|
71
|
-
|
|
72
|
-
```md
|
|
73
|
-
---
|
|
74
|
-
title: My First Post
|
|
75
|
-
date: 2026-01-08
|
|
76
|
-
tags:
|
|
77
|
-
- JavaScript
|
|
78
|
-
- Static Sites
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
Hello! This is my first blog post powered by Smirky.
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
> The `tags` field lets Smirky automatically generate tag pages and link posts to them.
|
|
85
|
-
|
|
86
|
-
4. Build your site:
|
|
87
|
-
|
|
88
|
-
```bash
|
|
89
|
-
npm run build
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
The generated site will be in the `dist/` folder. Deploy it anywhere: Netlify, Vercel, GitHub Pages, etc.
|
|
94
|
-
|
|
95
|
-
---
|
|
96
64
|
|
|
97
65
|
## How Themes Work
|
|
98
66
|
|
|
@@ -113,27 +81,6 @@ Partials are reusable components:
|
|
|
113
81
|
* `blog_post_card.html` — blog summary card
|
|
114
82
|
* `tag_pill.html` — tag label
|
|
115
83
|
|
|
116
|
-
Variables such as `{{ title }}`, `{{ content }}`, `{{ tag_pills }}`, `{{ site_title }}` are replaced automatically.
|
|
117
|
-
|
|
118
|
-
---
|
|
119
|
-
|
|
120
|
-
## Tags
|
|
121
|
-
|
|
122
|
-
* Tags are defined in Markdown frontmatter with `tags: [Tag1, Tag2]`
|
|
123
|
-
* Smirky generates:
|
|
124
|
-
|
|
125
|
-
* `/tags/` — index of all tags
|
|
126
|
-
* `/tags/{tag}/` — all posts with that tag
|
|
127
|
-
|
|
128
|
-
Tag pages automatically list posts that have the tag. Example URL:
|
|
129
|
-
|
|
130
|
-
```
|
|
131
|
-
/tags/javascript/
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
## Contact Forms (Fabform.io)
|
|
137
84
|
|
|
138
85
|
Smirky works with [Fabform.io](https://fabform.io) for contact forms without a backend.
|
|
139
86
|
|