You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/pages/markdown-reference.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,12 @@ Content that needs a citation.[^why]
50
50
[^why]: Footnote text shown at the bottom, or inline when hover tooltips are enabled.
51
51
```
52
52
53
+
Here's how it renders: Content that needs a citation.[^example]
54
+
55
+
[^example]: This is an example footnote rendered at the bottom of this page.
56
+
57
+
**Important**: The footnote definition (`[^id]: text`) must be separated from other content by a blank line, and must start at the beginning of a line (no indentation).
58
+
53
59
To switch to hover tooltips instead of a list, set in `config.json`:
Copy file name to clipboardExpand all lines: documentation/posts/index.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,16 @@ date: "2025-09-12"
8
8
9
9
Statik is a powerful static site generator built with **Kotlin** that combines simplicity with advanced features. This website itself is generated using Statik, serving as both documentation and a live example.
10
10
11
-
## ✨ Key Features
11
+
## Key Features
12
12
13
-
-**Zero Setup**: Works out of the box with built-in templates - no configuration required!
13
+
-**Zero Setup**: Works out of the box with built-in templates—no configuration required
14
14
-**Templates Optional**: Start with content only, customize templates later if desired
15
15
-**Markdown Processing**: Full support for GitHub Flavored Markdown with extensions
16
16
-**Docker Support**: Run anywhere with pre-built Docker images
17
17
-**Live Development**: Built-in server with hot reload during development
18
18
-**Flexible Configuration**: JSON-based configuration with sensible defaults
19
19
20
-
## 🚀 Quick Start
20
+
## Quick Start
21
21
22
22
**Super Simple** - Just create content and go:
23
23
@@ -46,7 +46,7 @@ docker run --rm -v $(pwd):/github/workspace ghcr.io/ptmt/statik:latest run -- --
46
46
./amper run -- --root-path=/path/to/your/site --w
47
47
```
48
48
49
-
## 📖 How This Site Works
49
+
## How This Site Works
50
50
51
51
This website demonstrates Statik's capabilities:
52
52
@@ -55,7 +55,7 @@ This website demonstrates Statik's capabilities:
55
55
3.**Static Assets**: CSS, JavaScript, and images are copied to the output
56
56
4.**GitHub Actions**: Automated building and deployment to GitHub Pages
57
57
58
-
## 🛠 Architecture
58
+
## Architecture
59
59
60
60
Statik follows a modular architecture:
61
61
@@ -65,7 +65,7 @@ Statik follows a modular architecture:
65
65
-`SiteGenerator`: Orchestrates the build process
66
66
-`FileWalker`: Efficiently traverses and processes file trees
67
67
68
-
## 📝 Markdown Extensions
68
+
## Markdown Extensions
69
69
70
70
This site showcases various Markdown features:
71
71
@@ -90,7 +90,7 @@ class BlogEngine(private val config: BlogConfig) {
90
90
}
91
91
```
92
92
93
-
## 🌟 Live Example
93
+
## Live Example
94
94
95
95
You're viewing a live example right now! This entire site is:
0 commit comments