This repository contains the markdown parser and plugin configuration we use for System76 websites.

Using

npm install --save @system76/markdown

<template>
  <article v-markdown.full>
    ## This will be parsed as markdown

    so type away!
  </article>
</template>

<script>
import { directive as markdownDirective } from '@system76/markdown'

export default {
  directives: {
    markdown: markdownDirective
  }
}
</script>

View the docs to see more examples.

Development

1. Download the repository

2. Run npm ci

3. Run npm start

4. Start hacking

5. Run npm test

6. Make a commit in Angular Commit Message Conventions format.

Deployment

To trigger a release, push a commit to the master branch in the Angular Commit Message Conventions format.