Skip to content

Commit eb0d40b

Browse files
committed
docs: update status tags and documentation formatting
1 parent 86d8b8a commit eb0d40b

3 files changed

Lines changed: 13 additions & 4 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Each module should be in its own file under `src/` and have a corresponding test
4545

4646
### Snippet Detection (MVP)
4747
Use this regex pattern for v0.1.0:
48+
4849
```
4950
/--8<--\s+["']([^"']+)["']/g
5051
```

IMPLEMENTATION.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,13 @@ block-style previews are deferred until VS Code supports this capability.
2323
- [MVP Success Metrics](#mvp-success-metrics)
2424
- [v0.2.0 - Enhanced Previews](#v020---enhanced-previews)
2525
- [Features In Scope](#features-in-scope)
26-
- [1. Named Section Support](#1-named-section-support)
27-
- [2. Line Range Support](#2-line-range-support)
26+
- [1. Named Section Support \[DONE in v0.1.1\]](#1-named-section-support-done-in-v011)
27+
- [2. Advanced Line Range Support](#2-advanced-line-range-support)
2828
- [3. Per-Snippet Toggle](#3-per-snippet-toggle)
29-
- [4. Configurable Preview Length](#4-configurable-preview-length)
29+
- [4. Block Format Support](#4-block-format-support)
30+
- [5. Disabled and Escaped Snippets](#5-disabled-and-escaped-snippets)
31+
- [6. URL Snippets](#6-url-snippets)
32+
- [7. Configurable Preview Length](#7-configurable-preview-length)
3033
- [5. Asynchronous File Loading](#5-asynchronous-file-loading)
3134
- [Development Tasks](#development-tasks)
3235
- [v0.3.0 - Robustness](#v030---robustness)
@@ -401,7 +404,8 @@ technical foundation.
401404

402405
## v0.2.0 - Enhanced Previews
403406

404-
**Goal:** Complete advanced snippet syntax support and enhance user experience with per-snippet controls.
407+
**Goal:** Complete advanced snippet syntax support and enhance user experience with
408+
per-snippet controls.
405409

406410
**Timeline:** 4 weeks (Weeks 5-8)
407411

@@ -506,6 +510,7 @@ technical foundation.
506510
**Description:** Support multi-file block format syntax.
507511

508512
**Syntax:**
513+
509514
```markdown
510515
--8<--
511516
file1.md
@@ -566,6 +571,7 @@ file3.md:10:20
566571
**Description:** Support including content from remote URLs.
567572

568573
**Syntax:**
574+
569575
```markdown
570576
--8<-- "https://raw.githubusercontent.com/user/repo/main/file.md"
571577
```

REQUIREMENTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,13 +273,15 @@ Requirement implementation status is marked as follows:
273273
- `;--8<-- "escaped.md"` - escaped snippet syntax (shows literally)
274274
- `--8<-- "https://example.com/file.md"` - URL snippet
275275
- **Block Format (Planned v0.2.0+):**
276+
276277
```markdown
277278
--8<--
278279
file1.md
279280
file2.md
280281
; disabled.md
281282
--8<--
282283
```
284+
283285
- **Examples:**
284286

285287
```markdown

0 commit comments

Comments
 (0)