adobe-markdown-authoring
Advanced tools
Readme
This is a Visual Studio Code extension that enhances the built-in Markdown preview feaures with Adobe extensions to the Markdown specification.
Currently this plugin extends the CommonMark specification, which is slightly different from the Git-flavored Markdown described in the Adobe Contributor Guide.
In addition to the standard markdown preview features provided by VS Code that adhere to the CommonMark specification, this extension attempts to provide a high-fidelity representation of Markdown that adheres to the custom Markdown syntax specified in the Adobe Markdown Syntax Style Guide.
The easiest way to install the Adobe Visual Studio Code Markdown Extensions is from the Visual Studio Code extension marketplace.
Here are some examples of the Adobe extensions in action. If you have the extension installed, it will format this document in the built-in VSCode preview panel. If you do not have the extension installed, the generic VSCode Markdown Preview will use the CommonMark spec to render the alert extensions as block quotes.
>[!NOTE]
>
>Here is a note component. Notice that it is just a blockquote that has a [!NOTE] label at the beginning of the code.
[!NOTE]
Here is a note component. Notice that it is just a blockquote that has a [!NOTE] label at the beginning of the code.
>[!CAUTION]
>
>Here is a caution component. Notice that it is just a blockquote and that you can _embed_ inline markdown including `pre-formatted text` and other **chicanery**
[!CAUTION]
Here is a caution component. Notice that it is just a blockquote and that you can embed inline markdown including
pre-formatted textand other chicanery
[!TIP]
Here is a tip [!TIP] This is after this.
> [!IMPORTANT]
>
> Here is the _IMPORTANT_ component. It's only one line.
[!IMPORTANT]
Here is the IMPORTANT component. It's only one line.
> [!TIP]
>
> Here is the _TIP_ component. It's only one line.
| Name | Description | Default key binding |
|---|---|---|
| md-shortcut.showCommandPalette | Display all commands | ctrl+M ctrl+M |
| md-shortcut.toggleBold | Make **bold** | ctrl+B |
| md-shortcut.toggleItalic | Make _italic_ | ctrl+I |
| md-shortcut.toggleStrikethrough | Make ~~strikethrough~~ | |
| md-shortcut.toggleLink | Make [a hyperlink](www.example.org) | ctrl+L |
| md-shortcut.toggleImage | Make an image  | ctrl+shift+L |
| md-shortcut.toggleCodeBlock | Make ```a code block``` | ctrl+M ctrl+C |
| md-shortcut.toggleInlineCode | Make `inline code` | ctrl+M ctrl+I |
| md-shortcut.toggleBullets | Make * bullet point | ctrl+M ctrl+B |
| md-shortcut.toggleNumbers | Make 1. numbered list | ctrl+M ctrl+1 |
| md-shortcut.toggleCheckboxes | Make - [ ] check list (Github flavored markdown) | ctrl+M ctrl+X |
| md-shortcut.toggleTitleH1 | Toggle # H1 title | |
| md-shortcut.toggleTitleH2 | Toggle ## H2 title | |
| md-shortcut.toggleTitleH3 | Toggle ### H3 title | |
| md-shortcut.toggleTitleH4 | Toggle #### H4 title | |
| md-shortcut.toggleTitleH5 | Toggle ##### H5 title | |
| md-shortcut.toggleTitleH6 | Toggle ###### H6 title | |
| md-shortcut.addTable | Add Tabular values | |
| md-shortcut.addTableWithHeader | Add Tabular values with header | |
| md-shortcut.toggleNote | Make a [!NOTE] block | ctrl+m ctrl+n |
| md-shortcut.toggleTip | Make a [!TIP] block | ctrl+m ctrl+t |
| md-shortcut.toggleCaution | Make a [!CAUTION] block | ctrl+m ctrl+c |
| md-shortcut.toggleImportant | Make an [!IMPORTANT] block | ctrl+m ctrl+p |
| md-shortcut.toggleWarning | Make a [!WARNING] block | ctrl+m ctrl+w |
| md-shortcut.toggleMoreLikeThis | Make a [!MORELIKETHIS] block | ctrl+m ctrl+m |
| md-shortcut.toggleVideo | Make a [!VIDEO] block | ctrl+m ctrl+v |
| md-shortcut.toggleDNL | Make a [!DNL] block | ctrl+m ctrl+d |
| md-shortcut.toggleUIControl | Make a [!UICONTROL] block | ctrl+m ctrl+u |
This package uses David Anson's Markdown-Lint package to validate the markdown. In addition to the built-in validation rules, this package adds support for Adobe Flavored Markdown.
When it starts up for the first time the Adobe Markdown Authoring extension will look for existing settings in the VSCode Settings. If it does not find them, it will add the default settings below. If it does find them, it will default to the values found in the user settings.
To change the settings, go to Preferences > Settings > markdownlint.
markdownlint.config: {
"line-length": false,
"AM001": false,
"AM009": false,
"AM011": false,
"MD003": {
"style": "atx"
},
"MD004": {
"style": "dash"
},
"MD007": {
"indent": 4
},
"MD009": false,
"MD012": false,
"MD014": false,
"MD024": false,
"MD025": {
"front_matter_title": ""
},
"MD026": false,
"MD027": false,
"MD028": false,
"MD030": {
"ul_multi": 3,
"ol_multi": 2
},
"MD033": {
"allowed_elements": [
"a",
"b",
"br",
"caption",
"code",
"col",
"colgroup",
"div",
"em",
"I",
"img",
"li",
"ol",
"p",
"pre",
"s",
"span",
"strong",
"sub",
"sup",
"table",
"tbody",
"td",
"tfoot",
"th",
"thead",
"tr",
"u",
"ul"
]
},
"MD036": false,
"MD038": false,
"MD039": false,
"MD040": false,
"MD045": false
}
In addition to the standard support MD### rules, Adobe Markdown Extension supports AM### rules, which are specific to Adobe Flavored Markdown.
"markdownlint.customRules": [
"{adobeexl.adobe-markdown-authoring}/markdownlint-custom-rules/rules.js"
]
Since this is an expansion on the built-in VS Code preview extension, any settings applicable to that extension also apply to this one. You can find more information about support for Markdown in Visual Studio Code at in the Visual Studio Code online documentation.
FAQs
Integrated preview, linter validation, and keyboard shortcuts for Adobe Flavored Markdown.
The npm package adobe-markdown-authoring receives a total of 9 weekly downloads. As such, adobe-markdown-authoring popularity was classified as not popular.
We found that adobe-markdown-authoring demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.