Skip to content

Commit b51a39a

Browse files
committed
feat: update documentation for v 0.8.0 (#681)
1 parent 306c279 commit b51a39a

File tree

3 files changed

+21
-345
lines changed

3 files changed

+21
-345
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33

44
This document records notable changes to LeafWiki, organized by release.
55

6+
## ✅ v0.8.0 – Sections & Importer
7+
8+
### Features & Improvements
9+
- [x] A new section type to organize pages into collapsible sections in the Tree View
10+
- [x] Markdown Importer to import existing markdown files and folders into the wiki structure
11+
- [x] Added reconstruct from disk functionality to rebuild the wiki structure from the markdown files on disk (useful for recovery and importer)
12+
- [x] Added more options to the Tree View context menu (e.g. create section, ...)
13+
- [x] Regular dependency updates
14+
15+
616
## ✅ v0.7.2 – Branding Settings, Installer Improvements & Search Tokenizer Update
717

818
### Features & Improvements

readme.md

Lines changed: 11 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -346,50 +346,6 @@ If you use this flag, **you are fully responsible for securing access at the net
346346
- `--public-access` for read-only public access
347347
- Viewer role for read-only access
348348

349-
## Migrating existing Markdown content (community tool)
350-
351-
If you already have an existing folder of Markdown files, you can bootstrap a LeafWiki navigation tree using a small community-contributed helper script.
352-
353-
354-
> **Community Tool**
355-
> Useful for **initial migration** from existing Markdown structures into LeafWiki.
356-
> Optional, provided “as is”. Contributions are welcome
357-
358-
The script:
359-
- Scans a Markdown directory (default: `data/root`)
360-
- Normalizes folder/file names to LeafWiki conventions (lowercase, hyphens)
361-
- Ensures every folder has an `index.md`
362-
- Generates a `data/tree.json` so LeafWiki can navigate the structure
363-
364-
Location: `tools/generate-tree.py`
365-
366-
### preview changes (dry-run mode)
367-
You can preview the changes without modifying any files using the `--preview` flag:
368-
369-
```bash
370-
python3 tools/generate-tree.py --root data/root --preview
371-
```
372-
373-
This will:
374-
- show proposed renames, skipped files and added index.md files
375-
- print a preview of the generated tree
376-
- perform no changes.
377-
378-
### Generate tree.json and normalize Markdown structure
379-
To actually apply the changes and generate `tree.json`, run:
380-
381-
```bash
382-
python3 tools/generate-tree.py --root data/root --output data/tree.json
383-
```
384-
385-
**Notes:**
386-
- It will rename files/folders to enforce LeafWiki naming conventions (lowercase, hyphens)
387-
- It will create blank `index.md` files in folders that lack them.
388-
- This is intended as a one-time import step
389-
- For ongoing structure management, use LeafWiki's UI.
390-
391-
> Contributed in [#523](https://github.com/perber/leafwiki/issues/523) - thanks to @nicgord
392-
393349
---
394350

395351
## Reconstruct Tree from Filesystem
@@ -459,6 +415,17 @@ leafwiki --data-dir /path/to/data reconstruct-tree
459415

460416
---
461417

418+
## Import Feature
419+
420+
LeafWiki includes a built-in Markdown Importer that allows you to import existing Markdown files and folders into the wiki structure.
421+
The importer is available as admin in the UI and can be used to quickly bring existing documentation into LeafWiki.
422+
423+
At the moment the importer does not support all features of the wiki (e.g. metadata, backlinks, assets, ...) but it provides a fast way to get started with existing Markdown content.
424+
425+
Please open an issue if you have specific feature requests or feedback for the importer.
426+
427+
---
428+
462429
## Quick Start (Dev)
463430

464431
```

tools/generate-tree.py

Lines changed: 0 additions & 301 deletions
This file was deleted.

0 commit comments

Comments
 (0)