Tips and Tricks

Markdownlint

To help with your Markdown formatting, install the markdownlint extension in VS Code. Click the square icon at the bottom of the left side to get to the extensions. Type "markdownlint" in the text box, and then click install. You will have to click "Reload" in order for your current window to get this. It will then show you places where you might have errors to look at. Hovering over the green squiggles will show what Markdownlint is complaining about.

You probably want to turn off a few rules that our convention violates. Create a file named .markdownlint.json in the root of your project, the same level as your guidebook.md file. Inside the file add this:

{
    "MD013": false,
    "MD024": false,
    "MD025": false
}

Any rule can be turned on or off by adding it to this file with a value of "true" or "false".

Syncing

In order to move your changes to GitHub and/or pull them down, you will use the Git Sync function of VS Code. In the Source Control section (3rd icon from the top on the left hand side), click the three dot menu, then choose Sync.

Converting from a Word Doc

If you have an existing Word document you can convert it with Pandoc.

1. Install Pandoc
2. Open your Terminal or Command window
4. Run: pandoc -f docx -t markdown --extract-media="." -o "name-of-your-output-md-file.md" "name-of-your-input-docx-file.docx"

Example: : pandoc -f docx -t markdown --extract-media="." -o "lab1234.md" "lab1234.docx" Expect to see all your document images under a folder named ‘media’ Edit ‘name-of-your-output-md-file.md’ in VS Code. (include the media folder in VS Code)