@entropicwarrior/sdoc 0.1.10 → 0.1.11

package/README.md

@@ -77,6 +77,72 @@ Or use the **SDOC: Browse Documents** command from the VS Code Command Palette.
 }
 ```
 
+## Features
+
+### Inline Formatting
+
+`*emphasis*`, `**strong**`, `~~strikethrough~~`, `` `inline code` ``, `[links](url)`, and `<https://autolinks>`.
+
+### Semantic Markers
+
+Annotate text with semantic meaning that renders as colored highlights:
+
+| Syntax | Meaning | Color |
+|---|---|---|
+| `{+text+}` | Positive | Green |
+| `{=text=}` | Neutral | Blue |
+| `{^text^}` | Caution | Amber |
+| `{!text!}` | Warning | Orange |
+| `{-text-}` | Negative | Red |
+| `{~text~}` | Highlight | Yellow |
+
+Markers nest with other inline formatting: `{+**all checks** passed+}`.
+
+### Math
+
+Inline math with `$x^2 + y^2$`, display math with `$$E = mc^2$$`, and multi-line equations with ` ```math ` code fences. Rendered via KaTeX.
+
+### Code Blocks
+
+Fenced with triple backticks, optional language tag for syntax highlighting. The `src:` directive includes external files inline:
+
+````
+```json src:./config.json lines:1-10
+```
+````
+
+### Mermaid Diagrams
+
+Code blocks tagged `mermaid` render as SVG diagrams — flowcharts, sequence diagrams, class diagrams, state diagrams, and more.
+
+### Images
+
+Markdown-style images with optional width and alignment:
+
+```
+![Photo](image.png =50% center)
+```
+
+### Tables
+
+Pipe-delimited tables with optional `borderless` and `headerless` flags.
+
+### Lists
+
+Bullet lists (`-`), numbered lists (`1.`), and task lists (`- [ ]` / `- [x]`). Items can have rich body content including nested lists, code blocks, and paragraphs.
+
+### References
+
+Tag any section with `@id` and cross-reference it anywhere with `@id` — renders as a clickable link.
+
+### Slides
+
+Turn any SDOC file into an HTML slide deck with themes, layouts (center, two-column), speaker notes, and PDF export.
+
+### Custom Styling
+
+Per-folder `sdoc.config.json` or per-file `@meta` scope for custom CSS, headers, footers, and confidentiality banners. Configs cascade from workspace root to file.
+
 ## Learning the Format
 
 - `docs/guide/intro.sdoc` — what SDOC is and why

package/lexica/sdoc-authoring.sdoc

@@ -181,7 +181,8 @@
                 \`\$\$E = mc^2\$\$\` | Display math (centered)
                 \`\{+text+\}\` | Positive marker (green)
                 \`\{=text=\}\` | Neutral marker (blue)
-                \`\{!text!\}\` | Warning marker (amber)
+                \`\{^text^\}\` | Caution marker (amber)
+                \`\{!text!\}\` | Warning marker (orange)
                 \`\{-text-\}\` | Negative marker (red)
                 \`\{~text~\}\` | Highlight (yellow)
             }
@@ -353,7 +354,7 @@
         {
             Backslash escapes special characters: \`\\\\\` \`\\{\` \`\\}\` \`\\@\`
             \`\\[\` \`\\]\` \`\\(\` \`\\)\` \`\\*\` \`\\~\` \`\\#\` \`\\!\` \`\\\<\`
-            \`\\\>\` \`\\\$\` \`\\+\` \`\\=\` \`\\-\`
+            \`\\\>\` \`\\\$\` \`\\+\` \`\\=\` \`\\-\` \`\\^\`
 
             A line starting with \`\\#\` renders as a literal \`#\` (not a heading). Use \`\\\$\` to prevent a dollar sign from starting math mode.
         }

package/lexica/specification.sdoc

@@ -454,7 +454,8 @@ Content of Section B.
                 - Display math: `$$E = mc^2$$` (centered block)
                 - Positive marker: `{+text+}` (green highlight)
                 - Neutral marker: `{=text=}` (blue highlight)
-                - Warning marker: `{!text!}` (amber highlight)
+                - Caution marker: `{^text^}` (amber highlight)
+                - Warning marker: `{!text!}` (orange highlight)
                 - Negative marker: `{-text-}` (red highlight)
                 - Highlight: `{~text~}` (yellow highlight)
             }
@@ -464,7 +465,7 @@ Content of Section B.
 
         # Escaping @escaping
         {
-            In normal text (including headings and paragraphs), a backslash escapes: `\\` `\{` `\}` `\@` `\[` `\]` `\(` `\)` `\*` `\~` `\#` `\!` `\<` `\>` `\$` `\+` `\=` `\-` and `` \` ``.
+            In normal text (including headings and paragraphs), a backslash escapes: `\\` `\{` `\}` `\@` `\[` `\]` `\(` `\)` `\*` `\~` `\#` `\!` `\<` `\>` `\$` `\+` `\=` `\-` `\^` and `` \` ``.
 
             Escapes are processed before reference detection.
 
@@ -788,7 +789,7 @@ Content of Section A.
             - Comment syntax (if any)
             - Duplicate ID resolution (error vs warning vs nearest-scope)
             - Additional list types (checkboxes, alpha, roman)
-            - Additional inline formatting (underline, highlight)
+            - Additional inline formatting (underline)
         }
     }
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@entropicwarrior/sdoc",
   "displayName": "SDOC",
   "description": "A plain-text documentation format with explicit brace scoping — deterministic parsing, AI-agent efficiency, and 10-50x token savings vs Markdown.",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "publisher": "entropicwarrior",
   "license": "MIT",
   "repository": {
@@ -113,6 +113,34 @@
     "configurationDefaults": {
       "[sdoc]": {
         "editor.wordWrap": "on"
+      },
+      "editor.tokenColorCustomizations": {
+        "textMateRules": [
+          {
+            "scope": "markup.quote.sdoc",
+            "settings": {
+              "foreground": "#3b82c3"
+            }
+          },
+          {
+            "scope": "markup.changed.sdoc",
+            "settings": {
+              "foreground": "#b08a1a"
+            }
+          },
+          {
+            "scope": "markup.keyword.warning.sdoc",
+            "settings": {
+              "foreground": "#d97706"
+            }
+          },
+          {
+            "scope": "markup.other.highlight.sdoc",
+            "settings": {
+              "foreground": "#a68a00"
+            }
+          }
+        ]
       }
     },
     "languageModelTools": [

package/src/notion-renderer.js

@@ -139,6 +139,7 @@ function flattenInlineNodes(nodes, annotations, href) {
         break;
       case "mark_positive":
       case "mark_neutral":
+      case "mark_caution":
       case "mark_warning":
       case "mark_negative":
       case "mark_highlight":

package/src/sdoc.js

@@ -8,7 +8,7 @@ const COMMAND_LIST_NUMBER = "{[#]";
 const COMMAND_TABLE = "{[table]";
 const COMMAND_CODE_FENCE = "```";
 
-const ESCAPABLE = new Set(["\\", "{", "}", "@", "[", "]", "(", ")", "*", "`", "#", "!", "~", "<", ">", "$", "+", "=", "-"]);
+const ESCAPABLE = new Set(["\\", "{", "}", "@", "[", "]", "(", ")", "*", "`", "#", "!", "~", "<", ">", "$", "+", "=", "-", "^"]);
 
 let _katex = null;
 let _katexLoaded = false;
@@ -1205,6 +1205,7 @@ function parseInline(text) {
       let mt = null;
       if (mc === "+") mt = "mark_positive";
       else if (mc === "=") mt = "mark_neutral";
+      else if (mc === "^") mt = "mark_caution";
       else if (mc === "!") mt = "mark_warning";
       else if (mc === "-") mt = "mark_negative";
       else if (mc === "~") mt = "mark_highlight";
@@ -1365,6 +1366,8 @@ function renderInlineNodes(nodes) {
           return `<span class="sdoc-mark sdoc-mark-positive">${renderInlineNodes(node.children)}</span>`;
         case "mark_neutral":
           return `<span class="sdoc-mark sdoc-mark-neutral">${renderInlineNodes(node.children)}</span>`;
+        case "mark_caution":
+          return `<span class="sdoc-mark sdoc-mark-caution">${renderInlineNodes(node.children)}</span>`;
         case "mark_warning":
           return `<span class="sdoc-mark sdoc-mark-warning">${renderInlineNodes(node.children)}</span>`;
         case "mark_negative":
@@ -1928,7 +1931,8 @@ const DEFAULT_STYLE = `
   }
   .sdoc-mark-positive { background-color: rgba(34, 139, 34, 0.15); color: #166016; }
   .sdoc-mark-neutral  { background-color: rgba(59, 130, 195, 0.15); color: #245d8a; }
-  .sdoc-mark-warning  { background-color: rgba(200, 150, 30, 0.18); color: #7a5f0e; }
+  .sdoc-mark-caution  { background-color: rgba(200, 150, 30, 0.18); color: #7a5f0e; }
+  .sdoc-mark-warning  { background-color: rgba(255, 120, 0, 0.18); color: #b35400; }
   .sdoc-mark-negative { background-color: rgba(187, 50, 50, 0.15); color: #911e1e; }
   .sdoc-mark-highlight { background-color: rgba(255, 255, 0, 0.75); }