mirror of
https://github.com/danbulant/lezer-markdown-obsidian
synced 2026-06-21 07:31:58 +00:00
Compare commits
4 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6223674c53 | ||
|
|
47bed7489e | ||
|
|
7ed8ebf669 | ||
|
|
d81022e19b |
6 changed files with 61 additions and 32 deletions
21
LICENSE
Normal file
21
LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2023 Eric Rykwalder
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
10
README.md
10
README.md
|
|
@ -29,10 +29,14 @@ import { Comment, InternalLink } from "lezer-markdown-obsidian";
|
|||
const parser = mdParser.configure([Comment, InternalLink]);
|
||||
```
|
||||
|
||||
### `ObsidianMDExtensions`
|
||||
### `Extensions`
|
||||
|
||||
An array of all the extensions for Obsidian's markdown syntax.
|
||||
|
||||
### `BlockAndInline`
|
||||
|
||||
An array of all the extensions except YAML frontmatter.
|
||||
|
||||
### `Comment`
|
||||
|
||||
This adds support for parsing comments in the form of: `%%comment%%`.
|
||||
|
|
@ -73,6 +77,10 @@ Internal embeds are structured like:
|
|||
|
||||
The `#heading` and `|display` parts are optional. Heading can be a `#^blockid` instead, and multiple headings can be chained together.
|
||||
|
||||
### `Mark`
|
||||
|
||||
This adds support for highlight marks in the form of `==highlighted==`.
|
||||
|
||||
### `TaskList`
|
||||
|
||||
This adds support for Obsidian's task lists, which allow support for arbitrary characters for tasks. This makes it different from GFM task lists.
|
||||
|
|
|
|||
4
package-lock.json
generated
4
package-lock.json
generated
|
|
@ -1,12 +1,12 @@
|
|||
{
|
||||
"name": "lezer-markdown-obsidian",
|
||||
"version": "0.0.2",
|
||||
"version": "0.0.3",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "lezer-markdown-obsidian",
|
||||
"version": "0.0.2",
|
||||
"version": "0.0.3",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@lezer/common": "^0.15.11",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "lezer-markdown-obsidian",
|
||||
"description": "Obsidian Markdown extensions for @lezer/markdown",
|
||||
"version": "0.0.2",
|
||||
"version": "0.0.3",
|
||||
"main": "dist/index.cjs",
|
||||
"module": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
|
|
|
|||
|
|
@ -19,6 +19,8 @@ declare module "@lezer/markdown" {
|
|||
}
|
||||
}
|
||||
|
||||
const CommentDelim = { resolve: "Comment", mark: "CommentMarker" };
|
||||
|
||||
export const Comment: MarkdownConfig = {
|
||||
defineNodes: ["Comment", "CommentMarker"],
|
||||
parseBlock: [
|
||||
|
|
@ -66,18 +68,17 @@ export const Comment: MarkdownConfig = {
|
|||
{
|
||||
name: "CommentInline",
|
||||
parse(cx: InlineContext, next: number, pos: number) {
|
||||
let match = /^%%[^\n]*[^\n\\]%%/.exec(cx.text.slice(pos - cx.offset));
|
||||
if (!match) {
|
||||
return -1;
|
||||
if (next == 37 && cx.char(pos + 1) == 37) {
|
||||
let canClose = true;
|
||||
if (
|
||||
cx.slice(cx.offset, pos).lastIndexOf("\n") >
|
||||
cx.slice(cx.offset, pos).lastIndexOf("%%")
|
||||
) {
|
||||
canClose = false;
|
||||
}
|
||||
return cx.addDelimiter(CommentDelim, pos, pos + 2, true, canClose);
|
||||
}
|
||||
const start = pos;
|
||||
const end = pos + match[0].length;
|
||||
return cx.addElement(
|
||||
cx.elt("Comment", start, end, [
|
||||
cx.elt("CommentMarker", start, start + 2),
|
||||
cx.elt("CommentMarker", end - 2, end),
|
||||
])
|
||||
);
|
||||
return -1;
|
||||
},
|
||||
},
|
||||
],
|
||||
|
|
@ -339,7 +340,7 @@ function parseDisplay(cx: InlineContext, start: number): Element | null {
|
|||
return null;
|
||||
}
|
||||
|
||||
const MarkDelim = { resolve: "Mark", mark: "MarkMarker" };
|
||||
export const MarkDelim = { resolve: "Mark", mark: "MarkMarker" };
|
||||
|
||||
export const Mark: MarkdownConfig = {
|
||||
defineNodes: ["Mark", "MarkMarker"],
|
||||
|
|
@ -396,6 +397,8 @@ export const TaskList: MarkdownConfig = {
|
|||
};
|
||||
/* End Copyright */
|
||||
|
||||
const TexDelim = { resolve: "TexInline", mark: "TexMarker" };
|
||||
|
||||
export const Tex: MarkdownConfig = {
|
||||
defineNodes: ["TexBlock", "TexInline", "TexMarker"],
|
||||
parseBlock: [
|
||||
|
|
@ -443,21 +446,15 @@ export const Tex: MarkdownConfig = {
|
|||
parseInline: [
|
||||
{
|
||||
name: "TexInline",
|
||||
parse(cx: InlineContext, _, pos: number) {
|
||||
let match = /^\$(?:[^$\t ][^$]*)?[^$\t \\]\$(\D|$)/.exec(
|
||||
cx.text.slice(pos - cx.offset)
|
||||
);
|
||||
if (!match) {
|
||||
parse(cx: InlineContext, next: number, pos: number) {
|
||||
if (next != 36 /* $ */) {
|
||||
return -1;
|
||||
}
|
||||
const start = pos;
|
||||
const end = start + match[0].length - match[1].length;
|
||||
return cx.addElement(
|
||||
cx.elt("TexInline", start, end, [
|
||||
cx.elt("TexMarker", start, start + 1),
|
||||
cx.elt("TexMarker", end - 1, end),
|
||||
])
|
||||
);
|
||||
const before = cx.slice(pos - 1, pos);
|
||||
const after = cx.slice(pos + 1, pos + 2);
|
||||
const canClose = /[^ \t]/.test(before) && !/\d/.test(after);
|
||||
const canOpen = /[^$ \t]/.test(after);
|
||||
return cx.addDelimiter(TexDelim, pos, pos + 1, canOpen, canClose);
|
||||
},
|
||||
},
|
||||
],
|
||||
|
|
@ -496,7 +493,7 @@ export const YAMLFrontMatter: MarkdownConfig = {
|
|||
],
|
||||
};
|
||||
|
||||
export const ObsidianMDExtensions = [
|
||||
export const Extensions = [
|
||||
Comment,
|
||||
Footnote,
|
||||
Hashtag,
|
||||
|
|
@ -509,4 +506,6 @@ export const ObsidianMDExtensions = [
|
|||
YAMLFrontMatter,
|
||||
];
|
||||
|
||||
export const parser = defParser.configure(ObsidianMDExtensions);
|
||||
export const BlockAndInline = Extensions.slice(0, -1);
|
||||
|
||||
export const parser = defParser.configure(Extensions);
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
export {
|
||||
BlockAndInline,
|
||||
Comment,
|
||||
Extensions,
|
||||
Footnote,
|
||||
Hashtag,
|
||||
InternalLink,
|
||||
Mark,
|
||||
ObsidianMDExtensions,
|
||||
parser,
|
||||
TaskList,
|
||||
Tex,
|
||||
|
|
|
|||
Loading…
Reference in a new issue