https://github.com/bmcminn/smackdown

A non-standard Markdown parser for Throwdown
https://github.com/bmcminn/smackdown

Last synced: about 1 month ago
JSON representation

A non-standard Markdown parser for Throwdown

• Host: GitHub
• URL: https://github.com/bmcminn/smackdown
• Owner: bmcminn
• License: mit
• Created: 2015-07-10T09:58:43.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-07-16T08:50:39.000Z (almost 10 years ago)
• Last Synced: 2025-02-01T21:11:57.212Z (3 months ago)
• Language: PHP
• Size: 156 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Smackdown

version: `0.0.1`

---

An opinionated, non-standard Markdown parser for [Throwdown](https://github.com/bmcminn/throwdown) built using PEGs (parsing expression grammers).

## Status

- Incomplete...

## Requirements

- PHP >= 5.4

## Config

The basic config is just initializing a basic Smackdown instance. This will have the default config outlined below:

```php

 '.md'  // file extension used by Smackdown->renderFile

    , 'directory'       => ''     // folder where Smackdown can find your content files

    , 'front_matter'    => false  // let Smackdown parse out your front_matter content for you

    , 'delimiters' => [

        'code_fence'    => '```'  //

      , 'code'          => '`'    //

      , 'numlist'       => '\.'   //

      , 'emphasis'      => '_'    //

      , 'strong'        => '__'   //

      , 'attr'          => ','    // when parsing [link](/extras)[they="separate"ATTR_DELIMITERthese="values"]

      ]

    ];

  $smackdown = new \Gbox\Smackdown($defaults);

?>

```