Skip to content

Commit

Permalink
Merge pull request #54 from irskep/feature/import-myst-redo
Browse files Browse the repository at this point in the history
Beginnings of experimental MyST support
  • Loading branch information
irskep authored Sep 11, 2024
2 parents fd8b23c + c030811 commit dbdd641
Show file tree
Hide file tree
Showing 35 changed files with 3,514 additions and 465 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
}
}
Binary file modified bun.lockb
Binary file not shown.
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))
22 changes: 22 additions & 0 deletions docs/src/foundations/markup_languages/myst.myst.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
md_variant: "myst"
order: -1
---

(using-myst=)
# Using MyST

You can try, but it doesn't work very well. This is a test page.

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

:::{directive}
:k: v

directive content
:::

{role}`roletext`

[link](/index)
Loading

0 comments on commit dbdd641

Please sign in to comment.