https://github.com/aharshac/cfm-parser

Parser for Collaborizm Flavoured Markdown, i.e, Markdown flavour used on Collaborizm.com
https://github.com/aharshac/cfm-parser

markdown markdown-editor markdown-to-html nodejs

Last synced: 2 days ago
JSON representation

Parser for Collaborizm Flavoured Markdown, i.e, Markdown flavour used on Collaborizm.com

• Host: GitHub
• URL: https://github.com/aharshac/cfm-parser
• Owner: aharshac
• License: mit
• Created: 2017-06-20T18:39:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-09T18:55:41.000Z (about 7 years ago)
• Last Synced: 2024-07-31T13:09:27.974Z (about 2 months ago)
• Topics: markdown, markdown-editor, markdown-to-html, nodejs
• Language: JavaScript
• Homepage: https://www.collaborizm.com
• Size: 57.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Collaborizm Flavoured Markdown Parser

[![Collaborizm](https://img.shields.io/badge/Collaborizm-Join%20now-blue.svg)](https://www.collaborizm.com/)

[![Build Status](https://travis-ci.org/aharshac/cfm-parser.svg?branch=master)](https://travis-ci.org/aharshac/cfm-parser)    

[![NPM](https://nodei.co/npm/cfm-parser.png?mini=true)](https://nodei.co/npm/cfm-parser)

 

## Installation

```

npm install cfm-parser

```

 

## Usage

```js

import { cfmToHtml } from 'cfm-parser'

// Add Prism nom-default language

// No need for markup, css, clike, javascript

// Refer http://prismjs.com/#languages-list

import 'prismjs/components/prism-markdown.js';

// Import default CSS stylesheet if not using custom

import 'cfm-parser/css/style.css'

// Import styles for CSS highlighting

// Refer http://prismjs.com/ for theme names

import 'prismjs/themes/prism-okaidia.css';

const md = '## *Markdown*'

const html = cfmToHtml(md)

```

 

## Reference

### Function `cfmToHtml(markdown, linkify, uiClass, domainName, sourceLineNumber)`

Converts Collaborizm Flavoured Markdown to HTML.    

* `markdown`    

  Collaborizm Flavoured Markdown

* `linkify`    

  Converts URLs to HTML hyperlinks    

  *Default*: **true**    

* `uiClass`    

  CSS class names for HTML output    

  *Default*: **object**    

  ```

  {

    atProfile: 'md-at-person',

    atProject: 'md-at-project',

    adHocTag: 'md-hashtag-adhoc',

    hashTag: 'md-hashtag',

    img: 'md-img',

    youtube: 'md-yt',

    table: 'md-table',

    blockquote: 'md-blockquote'

  }

  ```

* `domainName`    

  Domain name parameter for YouTube embed.    

  *Default*: **''**    

* `sourceLineNumber`    

  Add a `data-input-line` attribute to each topmost HTML element that corresponds to the line number of the source markdown    

  *Default*: **true**