Embed and highlight and preview markdown in any language which support line-comment or block-comment for vscode. Also used for interpreting text as markdown.
e.g. Quickly preview LaTeX/ Highlight python markdown cell/ Highlight julia markdown doc string
Embed & Highlight
preview
Five mode
splitter: ignore source code part and put<hr>as splitterignored: ignore source code partfenced: keep source code as fenced codefolded: keep source code as folded fenced coderaw: do nothing (for working with preview-inject)
splitter Help organize information
ignored
fenced
folded
raw
change it at settings.json - preview-mode
using preview-mode-language could setting for respective languages
provide setting to open preview automatically for listed languages
Do some actions in parsing, only support to do some replacing before parse markdown to html now.
settings.json for quickly LaTeX previewing.
"markdown-everywhere.preview-mode-language": {"latex":"raw"},
"markdown-everywhere.preview-mode-inject": [
{"language":"latex","path":".*","beforeSource":" let {src,options}=args\n const lines = src.split(/\\r?\\n|\\r\\n?/);\n let lino = -1;\n let currentOffset = 0;\n \n while (++lino < lines.length) {\n let pa=null;\n let line = lines[lino];\n\n // MD remove `\\label`, do not change number of lines, directly replace\n line=line.replace(/\\\\label{.*?}/g,'')\n\n // MD fix equation, add 3 more lines. fix offset for trace\n pa=/\\\\begin{(equation|display|alignat|aligned|align|multline|flalign)}/\n if (pa.exec(line)){\n line=line.replace(pa,(m)=>'\\n\\n$$\\n'+m)\n currentOffset+=3\n options.offset.push([lino + currentOffset, currentOffset])\n }\n\n // MD fix equation\n pa=/\\\\end{(equation|display|alignat|aligned|align|multline|flalign)}/\n if (pa.exec(line)){\n line=line.replace(pa,(m)=>m+'\\n$$\\n\\n')\n currentOffset+=3\n options.offset.push([lino + currentOffset, currentOffset])\n }\n\n lines[lino] = line;\n }\n return lines.join('\\r\\n');\n \n "}
],The JSON generated from issue. More applications may be listed in the issue.
Command "Extract as Markdown to Clipboard" (also in right-mouse-click context menu.)
Convert selection into Markdown format according to the rules and preview mode, place it into the clipboard.
Can be used to copy Markdown from formats similar to JSDoc, automatically ignoring the * at the beginning of each line.
whileSymbol or whileRegExp (if whileSymbol undefined) will be used for enhancing typing.
There will be some onEnterRules pushed to markdown.
So it will also affect the editing of normal markdown files.
You can turn off it in "settings.json".
onEnterRules checks the previous line, so it does not work on the first line of a markdown region.
Example:
// MD the first line
// MD the second lineAfter pressing enter at "e", it will automatically append "// MD ".
// MD the first line
// MD the second line
// MD change it at "settings.json"
You can put those into "settings.json" to adjust the color.
So that markdown can be easily distinguished from both code and comments.
"editor.tokenColorCustomizations": {
"[Default Dark+]": {
"textMateRules": [
{
"scope": "meta.embedded.block.everywhere.md markup.heading, meta.embedded.block.everywhere.md markup.bold",
"settings": {
"foreground": "#61aa71",
}
},
{
"scope": "meta.embedded.block.everywhere.md punctuation.definition.list.begin.markdown, meta.embedded.block.everywhere.md entity.name.tag",
"settings": {
"foreground": "#599aa5",
}
},
{
"scope": "meta.embedded.block.everywhere.md entity.other.attribute-name",
"settings": {
"foreground": "#98bdc4",
}
},
{
"scope": "meta.embedded.block.everywhere.md markup.inline.raw, meta.embedded.block.everywhere.md string",
"settings": {
"foreground": "#ceca8b",
}
},
{
"scope": "meta.embedded.block.everywhere.md, meta.embedded.block.everywhere.md meta.embedded",
"settings": {
"foreground": "#9abb87",
}
}
]
}
}(note that some languages require that you install an VS Code extension that provides a grammar for that language)
| Rule | Type | Example | Languages |
|---|---|---|---|
| number-sign-MD | LRSW | # MD # title # MD content |
coffeescript dockerfile git-commit git-rebase diff ignore properties makefile perl perl6 powershell python r ruby shellscript yaml cython julia cmake |
| number-sign | LRSM | # [markdown] # # title # content |
coffeescript dockerfile git-commit git-rebase diff ignore properties makefile perl perl6 powershell python r ruby shellscript yaml cython julia cmake |
| slash-star | MR | /* [markdown] * # title * content */ |
c cpp csharp css go groovy hlsl java javascriptreact javascript json jsonc less objective-c objective-cpp php rust scss shaderlab sql swift typescript typescriptreact antlr |
| double-slash-MD | LRSW | // MD # title // MD content |
c cpp csharp fsharp go groovy hlsl java javascriptreact javascript json jsonc less objective-c objective-cpp php rust scss shaderlab swift typescript typescriptreact antlr qasm-lang |
| double-slash | LRSM | // [markdown] // # title // content |
c cpp csharp fsharp go groovy hlsl java javascriptreact javascript json jsonc less objective-c objective-cpp php rust scss shaderlab swift typescript typescriptreact antlr qasm-lang |
| percentage-MD | LRSW | % MD # title % MD content |
matlab bibtex tex latex |
| percentage | LRSM | % [markdown] % # title % content |
matlab bibtex tex latex |
| number-sign-double-percentage | LRSM | # %% [markdown] # # highlight python markdown cell # for the vscode-python data-science feature |
coffeescript dockerfile git-commit git-rebase diff ignore properties makefile perl perl6 powershell python r ruby shellscript yaml cython julia cmake |
| triple-quote | BR | """ bar(x[, y]) julia standard markdown doc """ function bar(x, y) ... |
julia python |
| whitespace-triple-quote | MR | def abc(): """ xxx xxx xxx xxx """ ... |
julia python |
| brace-dash | BR | {- [markdown] # title content-} |
haskell purescript |
| double-dash-MD | LRSW | -- MD # title -- MD content |
haskell purescript |
| double-dash | LRSM | -- [markdown] -- # title % content |
haskell purescript |
| double-slash-exclamation | LRSW | //! # title //! content |
rust |
| triple-slash | LRSW | /// # title /// content |
rust |
| slash-start-exclamation | BR | /! # My Crate / |
rust |
Imitate rules and add new rules to "settings.json". And then run command "Build Markdown Embedding Rules" and then reload (press "F1", type "Build Markdown Embedding Rules" and "Reload Window"). And you need to run build command again when you update this extension.
Save the first element defaultRules to keep default rules. Remove to only use customized rules. Example:
"markdown-everywhere.customized-rules": [
"defaultRules",
{
"name": "number-sign-equals",
"beginRegExp": "#=\\s*\\[markdown\\]",
"endRegExp": "=#",
"example": "#= [markdown]<br># title<br>content<br>=#",
"languages": [
{ "name": "julia", "source": "source.julia" }
]
}
]There are 4 types of rules, corresponding to 4 implementations
LRSW
line rule starts with the mark
whileRegExp
// MD connecting line-comment
// MD each line starts with the markrule={
name: "double-slash-MD",
whileRegExp: "// MD",
example: "// MD # title<br>// MD content<br>",
languages: [
...languages.filter(l => l.comments.lineComment === "//"),
{ name: "antlr", source: "source.antlr" },
{ name: "qasm-lang", source: "source.qasm" },
]
}BR
block rule
beginRegExp+endRegExp
May introduce incorrect rendering, for example, use
"""as markdown content in the follow demo
""" [markdown]
block comment starts with a start mark
and finally a end mark
"""rule={
name: "triple-quote",
beginRegExp: "\"\"\"\\s*\\[markdown\\]",
endRegExp: "\"\"\"",
example: "\"\"\" [markdown]<br># title<br>content<br>\"\"\"",
languages: [
...languages.filter(l => JSON.stringify(l.comments.blockComment||"") === JSON.stringify(["\"\"\"", "\"\"\""])),
]
}preview will break in a situation like this, the current preview does not parse the statements
a=""" asd """you can custom rules without defaultRules to close the triple-quote rule
MR
mixed rule
beginRegExp+whileRegExp+endRegExp
May introduce incorrect rendering, for example, use
*/as markdown content in the follow demo
/* [markdown]
* block comment starts with a start mark
* and each line starts with the mark
* and finally a end mark
*/rule={
name: "slash-star",
beginRegExp: "/\\*\\s*\\[markdown\\]",
whileRegExp: "\\*(?!/)",
whileSymbol: "*",
endRegExp: "\\*/",
example: "/* [markdown]<br> * # title<br> * content<br> */<br>",
languages: [
...languages.filter(l => JSON.stringify(l.comments.blockComment||"") === JSON.stringify(["/*","*/"])),
{ name: "antlr", source: "source.antlr" },
]
}LRSM
line rule with a start mark
beginRegExp+whileRegExp
// [markdown]
// some connecting normal line-comment
// starts with a start mark (which is normaly a line-comment)rule={
name: "double-slash",
beginRegExp: "//\\s*\\[markdown\\]",
whileRegExp: "//",
example: "// [markdown]<br>// # title<br>// content<br>",
languages: [
...languages.filter(l => l.comments.lineComment === "//"),
{ name: "antlr", source: "source.antlr" },
{ name: "qasm-lang", source: "source.qasm" },
]
}There is bug for this case. The following first line will be highlighted as comment. I haven't figured out the mechanism yet. So please put a empty line after these.
Extending from my pr in vscode-python (issue/pr).
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent