Skip to content

Commit

Permalink
Let’s stop here since MyST obviously is not complete enough
Browse files Browse the repository at this point in the history
  • Loading branch information
irskep committed Sep 11, 2024
1 parent 88f89fe commit 56b65e0
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"[markdown]": {
"editor.formatOnSave": false
}
}
8 changes: 7 additions & 1 deletion docs/src/contributing/dependencies.dj
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,14 @@ Dependencies supporting the core functionality of Djockey:
- [parse5](https://www.npmjs.com/package/parse5): Spec-compliant HTML5 parsing
- [gluegun](https://github.com/infinitered/gluegun): Command line output

Dependencies supporting experimental MyST support:

- [myst-parser](https://www.npmjs.com/package/myst-parser)
- [myst-to-html](https://www.npmjs.com/package/myst-to-html)
- [mdast](https://github.com/syntax-tree/mdast)

Dependencies supporting individual features:

- [Shiki](https://shiki.style): Syntax highlighting
- [Mermaid](https://mermaid.js.org): Diagram rendering (pinned <11 due to broken TypeScript definitions)
- [Lunr](https://lunrjs.com): Site-wide search
- [Lunr](https://lunrjs.com): Site-wide search (though I am considering switching to [flexsearch](https://github.com/nextapps-de/flexsearch))
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
md_variant: "myst"
---

(using-myst=)
# Using MyST

{#normal-italic-bold}
normal _italic_ **bold**

:::{directive}
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/autoTitlePlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export class AutoTitlePlugin implements DjockeyPlugin {
doc.title = mystASTToText(node as mdast.Heading);
doc.titleASTDjot = mystASTToDjotAST_Inline(node);
doc.titleASTMyst = node;
return [EXIT];
return EXIT;
});
break;
}
Expand Down
2 changes: 2 additions & 0 deletions src/plugins/linkRewritingPlugin.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import fs from "fs";
import path from "path";

import { visit } from "unist-util-visit";

import {
DjockeyConfigResolved,
DjockeyDoc,
Expand Down
2 changes: 1 addition & 1 deletion src/utils/astUtils.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Block, Heading, Inline } from "@djot/djot";
import { visit } from "unist-util-visit";
import { Parent, PhrasingContent } from "mdast";
import { visit } from "unist-util-visit";

import { applyFilter } from "../engine/djotFiltersPlus.js";
import { DjockeyDoc, PolyglotDoc, PolyglotDoc_MDAST } from "../types.js";
Expand Down

0 comments on commit 56b65e0

Please sign in to comment.