Skip to content

Commit ef3f8a9

Browse files
committed
Let's try footnotes
1 parent 847d11d commit ef3f8a9

File tree

4 files changed

+179
-120
lines changed

4 files changed

+179
-120
lines changed

documentation/pages/markdown-reference.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@ Content that needs a citation.[^why]
5050
[^why]: Footnote text shown at the bottom, or inline when hover tooltips are enabled.
5151
```
5252

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+
5359
To switch to hover tooltips instead of a list, set in `config.json`:
5460

5561
```json

documentation/posts/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ date: "2025-09-12"
88

99
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.
1010

11-
## Key Features
11+
## Key Features
1212

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 templatesno configuration required
1414
- **Templates Optional**: Start with content only, customize templates later if desired
1515
- **Markdown Processing**: Full support for GitHub Flavored Markdown with extensions
1616
- **Docker Support**: Run anywhere with pre-built Docker images
1717
- **Live Development**: Built-in server with hot reload during development
1818
- **Flexible Configuration**: JSON-based configuration with sensible defaults
1919

20-
## 🚀 Quick Start
20+
## Quick Start
2121

2222
**Super Simple** - Just create content and go:
2323

@@ -46,7 +46,7 @@ docker run --rm -v $(pwd):/github/workspace ghcr.io/ptmt/statik:latest run -- --
4646
./amper run -- --root-path=/path/to/your/site --w
4747
```
4848

49-
## 📖 How This Site Works
49+
## How This Site Works
5050

5151
This website demonstrates Statik's capabilities:
5252

@@ -55,7 +55,7 @@ This website demonstrates Statik's capabilities:
5555
3. **Static Assets**: CSS, JavaScript, and images are copied to the output
5656
4. **GitHub Actions**: Automated building and deployment to GitHub Pages
5757

58-
## 🛠 Architecture
58+
## Architecture
5959

6060
Statik follows a modular architecture:
6161

@@ -65,7 +65,7 @@ Statik follows a modular architecture:
6565
- `SiteGenerator`: Orchestrates the build process
6666
- `FileWalker`: Efficiently traverses and processes file trees
6767

68-
## 📝 Markdown Extensions
68+
## Markdown Extensions
6969

7070
This site showcases various Markdown features:
7171

@@ -90,7 +90,7 @@ class BlogEngine(private val config: BlogConfig) {
9090
}
9191
```
9292

93-
## 🌟 Live Example
93+
## Live Example
9494

9595
You're viewing a live example right now! This entire site is:
9696

0 commit comments

Comments
 (0)