/nunjucks-markdown

Render markdown files using Nunjucks template engine

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

nunjucks-markdown

Render Markdown files using Nunjucks template engine.

Activation

Enable the rendering of Nunjucks templates on VSCode Markdown preview by starting the *.md file with the marker [//]: # "nunjucks" Use the marker [//]: # "nunjucks-dbg" to show the rendered Markdown instead.

Full Nunjucks support

You can use all of Nunjucks filters, tags, expressions and functions.

basics

Template inheritance and includes

You can use template inheritance and includes. The extension will load the files relative to /, in case you open a single file, or relative to the workspace root folder the file is child of, in case of workspaces or Multi-root Workspaces.

inheritance

Encryption

  • Set your encryption password with the Nunjucks Markdown: Set Encryption Password command. It will be cached during the editor session.
  • Use the Nunjucks Markdown: Encrypt command to encrypt the editor selection in place.
  • Use the | decrypt Nunjucks filter to decrypt the secret in the Markdown preview.

encrypt

  • If the encryption password is not set or is wrong the #ENCRYPTED# text will be rendered. This text can be overridden in the filter using | decrypt('<secret>').

encrypted

  • Use the Nunjucks Markdown: Decrypt command to decrypt the editor selection in place.

For more information

Credits

This extension uses the grammar provided by Nunjucks extension by ronnidc and injects it on the Markdown grammar provided by Microsoft.