Skip to content

Commit 5bc5973

Browse files
committed
docs: improv
1 parent 05a13e0 commit 5bc5973

File tree

4 files changed

+13
-2
lines changed

4 files changed

+13
-2
lines changed

docs/guide.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ order: 2
55

66
# Guide
77

8-
You probably want to start from [[markdown]], then [[query]] and thereon to [[yaml-config]]. See also [[js]].
8+
This guide covers Emanote's core features:
9+
10+
- **[[markdown]]** — Markdown extensions: wiki-links, callouts, task lists, emojis
11+
- **[[query]]** — Obsidian-style embed queries for dynamic content
12+
- **[[yaml-config]]** — Site metadata and per-page configuration
13+
- **[[html-template]]** — Full HTML customization with Heist templates
14+
- **[[layer]]** — Merging multiple notebook directories
915

1016
```query
1117
path:./*

docs/guide/markdown.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Wiki-links [do not yet](https://github.com/srid/emanote/discussions/105) support
2626

2727
### Broken links
2828

29-
Broken links render differently, for example: [[Foo bar]] (if a wiki-link) or [Foo bar](foo-bar.md) (if a regular Markdown link).
29+
Broken links render with a distinctive red/error style to help you identify missing notes. For example: [[Foo bar]] (wiki-link) or [Foo bar](foo-bar.md) (Markdown link). Fix by creating the target file or correcting the link path.
3030

3131
### Ambiguous links
3232

docs/start/known-issues.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ slug: known-issues
55

66
# Known Issues
77

8+
> [!note]
9+
> Emanote is stable software. This page documents rare edge cases.
10+
811
## Unicode issues
912

1013
If the generated site (or the Nix build) does not use the expected Unicode characters, you can try setting the `LC_ALL=C.UTF-8` environment variable before running emanote. See [\#125](https://github.com/srid/emanote/issues/125) for details.

docs/tips.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ slug: tips
55

66
# Tips
77

8+
Practical tips and recipes for common Emanote workflows.
9+
810
```query
911
path:./*
1012
```

0 commit comments

Comments
 (0)