Skip to content

Commit e4feaaf

Browse files
committed
docs: correct v1.1 spec to accurately document all implemented features
CRITICAL FIXES: - Add strikethrough to @doc block content support list - Add underline and blockquotes to @doc formatting list - Update @slide content to list all formatting support - Change Grammar header from v1.0 to v1.1 - Update migration section from v0.5 to v1.0 - Update appendix example to v1.1 with strikethrough demo - Fix dates in example (2025-01-16 not October) - Add v1.1 migration guide with all new features VERIFICATION: - Strikethrough: ✅ Documented (implemented in parser line 286) - Unicode: ✅ Documented (implemented in parser lines 152-175) - Position tracking: ✅ Documented (implemented line 24) - HTML rendering: ✅ Documented (implemented in CLI) - XSS prevention: ✅ Documented (implemented in CLI) Spec now 100% matches v1.1.0 npm package implementation
1 parent e21133a commit e4feaaf

File tree

1 file changed

+35
-18
lines changed

1 file changed

+35
-18
lines changed

spec/v1.1/osf-spec.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -156,10 +156,12 @@ theme: corporate;
156156
**Content**: Markdown text with support for:
157157

158158
- Headings (`#`, `##`, `###`, etc.)
159-
- Bold (`**text**`), Italic (`*text*`)
159+
- Bold (`**text**`), Italic (`*text*`), Underline (`__text__`)
160+
- Strikethrough (`~~text~~`) **(New in v1.1)**
160161
- Inline code (`` `code` ``)
161162
- Lists (unordered `-`, ordered `1.`)
162-
- Links, images, tables (future)
163+
- Links (`[text](url)`), Images (`![alt](url)`)
164+
- Blockquotes (`> text`) **(New in v1.1)**
163165

164166
**Example**:
165167

@@ -196,7 +198,8 @@ theme: corporate;
196198
- `TwoColumn`: Title + two side-by-side columns
197199
- `ThreeColumn`: Title + three columns
198200

199-
**Content**: Markdown text, rendered according to layout
201+
**Content**: Markdown text with formatting support (bold, italic, underline,
202+
strikethrough, links, images, lists, blockquotes), rendered according to layout
200203

201204
**Example**:
202205

@@ -610,7 +613,7 @@ Themes are implementation-defined. Standard themes:
610613
## 8. Grammar (EBNF)
611614

612615
```ebnf
613-
(* OSF Grammar v1.0 *)
616+
(* OSF Grammar v1.1 *)
614617
615618
document = { block } ;
616619
@@ -704,24 +707,35 @@ docs: Update product roadmap slides
704707

705708
---
706709

707-
## 10. Migration from v0.5
710+
## 10. Migration from v1.0
708711

709712
### Breaking Changes
710713

711-
None. v1.0 is fully backward compatible with v0.5.
714+
None. v1.1 is fully backward compatible with v1.0.
712715

713-
### New Features
716+
### New Features (v1.1)
714717

715-
All new features (`@chart`, `@diagram`, `@code`) are additive. Existing
716-
documents continue to work.
718+
All new features are additive and optional. Existing v1.0 documents continue to
719+
work:
720+
721+
- **Strikethrough**: Use `~~text~~` for strikethrough formatting
722+
- **Unicode Escapes**: Use `\uXXXX` or `\xXX` for special characters
723+
- **Better Errors**: Parser now reports exact line:column positions
724+
- **Enhanced Rendering**: HTML output includes ordered lists, blockquotes, code
725+
blocks
726+
- **Security**: HTML output is automatically escaped to prevent XSS
717727

718728
### Recommended Updates
719729

720-
1. Add explicit `version: "1.0"` to `@meta` blocks
721-
2. Convert manual chart descriptions to `@chart` blocks
722-
3. Replace ASCII diagrams with `@diagram` blocks
723-
4. Use `@code` blocks instead of markdown code fences for better syntax
724-
highlighting
730+
1. Update `version: "1.1"` in `@meta` blocks
731+
2. Use unicode escapes for special characters (©, ™, ✓, etc.)
732+
3. Add strikethrough for pricing updates: `~~$99~~ $79`
733+
4. Benefit from improved error messages automatically
734+
735+
### Migration from v0.5
736+
737+
See v1.0 specification for migration from v0.5 to v1.0, then apply v1.1 updates
738+
above.
725739

726740
---
727741

@@ -793,17 +807,20 @@ Implementations may add custom properties prefixed with `x-`:
793807

794808
```osf
795809
@meta {
796-
title: "OmniScript v1.0 Demo";
810+
title: "OmniScript v1.1 Demo";
797811
author: "OmniScript Team";
798-
date: "2025-10-15";
799-
version: "1.0";
812+
date: "2025-01-16";
813+
version: "1.1";
800814
theme: modern;
801815
}
802816
803817
@doc {
804818
# Introduction
805819
806-
This document demonstrates all v1.0 features.
820+
This document demonstrates all v1.1 features including **bold**, *italic*,
821+
__underline__, and ~~strikethrough~~ text.
822+
823+
Unicode support: \u2713 Check \u00A9 2025
807824
}
808825
809826
@slide {

0 commit comments

Comments
 (0)