Skip to content

Update README.md documentation #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Tnixc merged 1 commit into from
Nov 5, 2025
Merged

Update README.md documentation #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ data. I used it to build v6 of https://enochlau.com

### Core

- [ ] Proper error handling (no unwraps please)
- [ ] Switch to using a .config file for configuration
- [ ] Implement caching based on file hashes to avoid unnecessary rebuilds

Expand All @@ -32,14 +31,16 @@ data. I used it to build v6 of https://enochlau.com
### Perf

- [ ] Implement selective component caching to reduce disk reads
- [ ] Conduct and analyze more extensive speed tests

### Syntax/Parsing

- [ ] Improve escaping for special characters ({}, "", etc.) (needed?)

### Done

- [x] Proper error handling (removed all unwrap/expect calls)
- [x] Performance optimization with Rayon parallelization (12% faster)
- [x] Strip frontmatter from markdown before rendering
- [x] KaTeX support
- [x] Handle port collisions in dev server
- [x] Resolve dual sources of truth for Markdown frontmatter in blog posts (can't fix without proper Markdown parsing into entries)
Expand Down Expand Up @@ -226,7 +227,7 @@ date: Jan 1 2025
Your markdown content...
```

The frontmatter will automatically generate the data needed for templating. The following fields are auto-generated:
The frontmatter is automatically stripped before rendering and used to generate the data needed for templating. The following fields are auto-generated:
- `--entry-path`: Set to the markdown file path
- `--result-path`: Set to `content/{filename}.html`
- `link`: Set to `./content/{filename}.html`
Expand Down