https://github.com/system76/markdown

System76 markdown parsing for the web
https://github.com/system76/markdown

Last synced: 2 months ago
JSON representation

System76 markdown parsing for the web

• Host: GitHub
• URL: https://github.com/system76/markdown
• Owner: system76
• License: gpl-3.0
• Created: 2020-02-10T17:14:18.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-01T03:17:42.000Z (almost 2 years ago)
• Last Synced: 2024-09-22T11:05:39.936Z (4 months ago)
• Language: JavaScript
• Homepage: https://markdown.origin76.com
• Size: 9.32 MB
• Stars: 6
• Watchers: 7
• Forks: 1
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  
@system76/markdown

  
System76 markdown parsing for the web

  


  






  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



---

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

System76 websites.

## Using

```

npm install --save @system76/markdown

```

```vue

  

    ## This will be parsed as markdown

    so type away!

  

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

export default {

  directives: {

    markdown: markdownDirective

  }

}

```

View [the docs](https://markdown.origin76.com) 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](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)

format.

## Deployment

To [trigger a release](https://semantic-release.gitbook.io/semantic-release/#triggering-a-release),

push a commit to the `master` branch in the

[Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)

format.