Home

Welcome to the Vultron wiki!

Markdown Style Guide

Markdown gives you more options, but these are for consistency:

• use asterisks for *emphasis* → emphasis
• use asterisks for **strong** → strong
• use dashes for - bullets

Markdown Lint

Markdownlint-cli2 will be run against pull requests to main, so it's good to get in the habit of using it.

$ markdownlint-cli2 --config .markdownlint-cli2.yaml --fix "**/*.md" "#node_modules"

The config file rules are explained in the markdownlint-cli2 documentation.

Publication

There is a github workflow that watches the publish branch. Most PRs for development should be made against the main branch, and then we'll push main to publish when we tag a release. This is a manual process for now.