remark-encrypted-block
This plugin parses custom Markdown syntax to create an encrypted block that gets rendered into an script tag.
Usage is pretty basic, just add a link pointing to #!encrypt
and everything after will
be encrypted using node-rsa
and rendered to base64
.
Syntax
This will not be encrypted.[\#!encrypt]()This will be encrypted.Also this.
produces:
This will not be encrypted
You need to configure by setting a public key string (format pkcs1-public-pem
)
under the configuration object key named key
.
key: '-----BEGIN RSA PUBLIC KEY-----${pubKey}-----END RSA PUBLIC KEY-----'
Installation
npm:
npm install --save remark-encrypted-block
Usage
Dependencies:
const unified = const remarkParse = const stringify = const remark2rehype = const remarkCustomBlocks =
Usage:
The sample configuration provided above would have the following effect:
-
Allows you to use the following Markdown syntax to define the beginning of the encrypted block:
This will not be encrypted.[\#!encrypt]()This will be encrypted.Also this. -
This Remark plugin would create a mdast node for the encrypted block, this node would be of type:
encryptedBlock
-
If you're using rehype, you will end up with a
script
like this:
License
ISC