@pretextbook/remark-pretext 0.0.1

package/README.md

@@ -0,0 +1,76 @@
+# @pretextbook/remark-pretext
+
+A [remark](https://github.com/remarkjs/remark) plugin that transforms **markdown-style PreTeXt** into a [`@pretextbook/ptxast`](../ptxast) tree.
+
+## What is markdown-style PreTeXt?
+
+Standard Markdown extended with [generic directives](https://github.com/remarkjs/remark-directive) to express PreTeXt-specific environments:
+
+```markdown
+## Pythagorean Theorem
+
+A paragraph with inline $math$ and **important** terms.
+
+::::theorem[Pythagorean Theorem]{#thm-pythagoras}
+For a right triangle with legs $a$, $b$ and hypotenuse $c$:
+
+$$
+a^2 + b^2 = c^2
+$$
+
+:::proof
+Left as an exercise.
+:::
+::::
+```
+
+## Usage
+
+```ts
+import { unified } from 'unified'
+import remarkParse from 'remark-parse'
+import remarkDirective from 'remark-directive'
+import { remarkPretext } from '@pretextbook/remark-pretext'
+
+const processor = unified()
+  .use(remarkParse)
+  .use(remarkDirective)   // enables ::: directives
+  .use(remarkPretext)
+
+const mdast = processor.parse(markdownString)
+const ptxast = processor.runSync(mdast, { value: markdownString }) // PtxRoot
+
+// Serialize to XML (use @pretextbook/ptxast-util-to-xml)
+```
+
+> **Note:** Use `.runSync()` (or `.run()`) rather than `.parse()` — `.parse()` only runs the parser phase; transformers (including `remarkPretext`) run during the transform phase.
+
+## Syntax Rules
+
+- `:::name[optional title]{#id attr=val}` opens a block directive
+- `:::` alone closes it
+- **Nesting**: use one more colon for the outer container when nesting directives:
+  - `::::theorem` containing `:::proof` — use `::::` for theorem, `:::` for proof
+- All standard PreTeXt block names are recognised (see `DIRECTIVE_MAP`)
+- Standard Markdown headings map to divisions:
+  - `#` → `<chapter>`
+  - `##` → `<section>`
+  - `###` → `<subsection>`
+  - `####` → `<subsubsection>`
+- Inline elements:
+  - `*text*` → `<em>`
+  - `**text**` → `<alert>` (semantic emphasis in PreTeXt)
+  - `` `code` `` → `<c>`
+  - `$...$` and `\(...\)` → `<m>`
+  - `$$...$$` and `\[...\]` → display math (`<md>`)
+
+## Supported Directives
+
+| Category | Names |
+|----------|-------|
+| theorem-like | `theorem`, `lemma`, `corollary`, `proposition`, `claim`, `fact`, `conjecture`, `axiom`, `principle`, `hypothesis`, `algorithm` |
+| definition-like | `definition`, `notation` |
+| remark-like | `remark`, `note`, `observation`, `warning`, `insight`, `assemblage` |
+| example-like | `example`, `question`, `problem`, `exercise`, `activity`, `exploration`, `investigation`, `project` |
+| proof-like | `proof`, `case` |
+| solution-like | `solution`, `hint`, `answer` |

package/index.cjs

@@ -0,0 +1 @@
+module.exports = require('../../dist/packages/remark-pretext/index.cjs');

package/index.d.ts

@@ -0,0 +1 @@
+export * from '../../dist/packages/remark-pretext/index.d.ts';

package/index.js

@@ -0,0 +1 @@
+export * from '../../dist/packages/remark-pretext/index.js';

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@pretextbook/remark-pretext",
+  "version": "0.0.1",
+  "description": "remark plugin to transform markdown-style PreTeXt directives into ptxast",
+  "author": "Oscar Levin",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pretextbook/pretext-tools.git"
+  },
+  "bugs": {
+    "url": "https://github.com/pretextbook/pretext-tools/issues"
+  },
+  "homepage": "https://github.com/pretextbook/pretext-tools/packages/remark-pretext#readme",
+  "private": false,
+  "type": "module",
+  "main": "./index.cjs",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "default": "./index.js"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "*.js",
+    "*.cjs",
+    "*.d.ts",
+    "*.d.cts",
+    "lib",
+    "types"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@pretextbook/ptxast": "^0.0.1",
+    "@types/mdast": "^4.0.0",
+    "mdast-util-directive": "^3.0.0",
+    "remark-directive": "^4.0.0",
+    "remark-parse": "^11.0.0",
+    "unified": "^11.0.0",
+    "unist-util-visit": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}