Skip to content

Commit b0bf4c9

Browse files
committed
chore: cleanup README header
1 parent 597897f commit b0bf4c9

File tree

1 file changed

+22
-26
lines changed

1 file changed

+22
-26
lines changed

README.md

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
1-
<div style="display: flex; align-items: center; justify-content: space-between;">
2-
<div style="flex: 1;">
3-
<h1>fssg</h1>
4-
<p><strong>fssg</strong> is a portable, dependency-free static site generator written entirely
5-
in POSIX shell and AWK. It recursively processes Markdown (.md) and .html
6-
files in <code>src/</code> and outputs a minified, deployable website in <code>dist/</code>.</p>
7-
</div>
8-
<div>
9-
<a href="https://github.com/xlc-dev/fssg">
10-
<img src="./src/static/img/logo.png" alt="fssg Logo" width="150">
11-
</a>
12-
</div>
13-
</div>
1+
<img src="./src/static/img/logo.png" alt="fssg Logo" width="150" align="right">
2+
3+
# fssg
4+
5+
**fssg** is a portable, dependency-free static site generator written entirely
6+
in POSIX shell and AWK. It recursively processes markdown and html
7+
files in `src/` and outputs a minified, deployable website in `dist/`.
148

159
## Table of Contents
1610

@@ -80,9 +74,9 @@ chmod +x ./my-site/fssg
8074
2. **Write content** in `src/` as `.md` or `.html`.
8175
3. **Run the generator**:
8276

83-
```sh
84-
./fssg
85-
```
77+
```sh
78+
./fssg
79+
```
8680

8781
4. **Browse output** in `dist/`.
8882

@@ -138,7 +132,7 @@ your-project/
138132

139133
`src/index.md`:
140134

141-
````markdown
135+
```markdown
142136
{{title: Home}}
143137

144138
# Welcome to My Site
@@ -197,20 +191,18 @@ Usage in a page:
197191
Usage in a page:
198192

199193
```html
200-
{{ include-block:alert.html type="warning" alert_title="Attention" markdown="true" }}
201-
This is **Markdown** content inside the block.
202-
{{ endinclude }}
194+
{{ include-block:alert.html type="warning" alert_title="Attention"
195+
markdown="true" }} This is **Markdown** content inside the block. {{ endinclude
196+
}}
203197
```
204198

205199
### Conditional Content
206200

207201
```html
208202
{{ IF_EXT:md }}
209-
<p>This only appears in Markdown-converted pages.</p>
210-
{{ ENDIF_EXT }}
211-
212-
{{ IF_PAGE:about.html }}
213-
<p>This only appears in Markdown-converted pages.</p>
203+
<p>This only appears in Markdown-converted pages.</p>
204+
{{ ENDIF_EXT }} {{ IF_PAGE:about.html }}
205+
<p>This only appears in Markdown-converted pages.</p>
214206
{{ ENDIF_PAGE }}
215207
```
216208

@@ -248,4 +240,8 @@ For full details, see the [fssg Documentation Website](https://xlc-dev.github.io
248240

249241
## License
250242

251-
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
243+
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
244+
245+
```
246+
247+
```

0 commit comments

Comments
 (0)