@ahl389/markdoctor NPM

Markdoctor

A markdown parser and converter that will turn markdown files into properly formatted Google Docs files and upload them to your Google Drive.

Usage

INSTALLATION
$ npm install -g @ahl389/markdoctor

VERSION CHECKING
$ markdoctor (-v|--version|version)
@ahl389/markdoctor/0.0.1 darwin-x64 node-v14.17.2

USAGE
$ markdoctor run path/to/file.md
$ markdoctor login

Format

When writing your article for use with markdoctor, you can generally write markdown exactly as you're used to. However, because some markdown needs to be preserved in the final Google doc, in order to be imported into Wagtail, you must keep in mind the following two rules:

Inline code

For inline code, in typical markdown or when writing directly in Google docs, you would use a backtick before and after the code, like this:

In the code above, `const var = 1`, is an example of a variable declaration.

For this formatting to be preserved from your markdown file into Google Docs, you must escape your backticks:

In the code above, \`const var = 1\`, is an example of a variable declaration.

Fenced code blocks

In order to preserve your fenced code blocks when your markdown file is converted to Google Docs, be sure to prefix and suffix them with ~~~, as shown below:

~~~ ```javascript hl_lines="1" const myvar = 1; ``` ~~~