scribe/swim-bundle

Simple and extensible parser library for markdown, Swim, and more...

Installs: 534

Dependents: 2

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Type: project

dev-master / 2.4.x-dev 2016-03-07 12:29 UTC

README

Continuous Integration Code Quality Review UnitTest Coverage
Travis Codacy Coveralls

Overview

Welcome! The scr-be/teavee-scribble-down-bundle package provides a Markdown-based rendering engine with additional features.

Grouping

This package is part of the teavee group (explanation), comprised of other releases with a concentration in media, HTML, content, generator, and related functionality.

JTT

This package represents a single project within a large collection of open-source code released under the Scribe namespace, comprised of framework-agnostic libraries, and a number of Symfony bundles. These projects are authored and maintained by Rob Frawley 2nd and collaborators, often with the support of Scribe Inc.

Quick Start

Installation

Get the code by requiring it explicitly via the Composer CLI, or by editing your composer.json to reflect the dependency and updating your project requirements. For example, to explicitly require this project using the CLI, use the following command.

$ composer require scr-be/teavee-scribble-down-bundle

To enable the bundle, register it with your Symfony application kernel by instantiating ScribeTeaveeScribbleDownBundle within the bundle array.

// app/AppKernel.php
class AppKernel extends Kernel {
    public function registerBundles() {
        $bundles = [
            // ...
            new Scribe\Teavee\ScribbleDownBundle\ScribeTeaveeScribbleDownBundle(),
        ];
        // ...
    }
}

Configuration

Available configuration values can be referenced by using the Symfony console command app/console (assuming the Symfony full-stack framework and bundle registration). Additionally, this bundle provides a bare console executable that can be invoked by calling the following.

bin/teavee-scribble-down config:dump-reference scribe_teavee_scribble_down

Reference

API Docs

This package's API-documentation is available at scr.be/teavee-scribble-down-bundle/api, (as well as linked below via the Reference badge found under the Additional Links header). All API-reference is build against the master Git branch and updated automatically on each Git push---api-reference for specific releases will be provided once this package has matured.

The entire API-reference website is auto-generated using a quick, reliable, and well-developed CLI tool called Sami. It is rigerously and regularly tested through its use in large, complex projects, such as the Symfony Full-Stack Framework , as well as its use in smaller projects such Twig . Reference Sami's GitHub page to learn how to use it with your own projects!

Examples/Tutorials

Currently, there is no "human-written" documentation---outside of this README. Pending package stability and available resources, a RTD (Read the Docs) page will be published with additional information and tutorials, including real use-cases within the Symfony Framework.

Contributing

Discussion

For general inquiries or to discuss a broad topic or idea, you can find robfrawley on Freenode. There is also a #scribe channel, which can be joined using the following link irc.choopa.net:6669/scribe.

Issues

To report issues or request a new feature use GitHub or GitLab to start a discussion. Include as much information as possible to aid in a quick resolution. Feel free to "ping" the topic if you don't get a response within a few days.

Code

You created additional functionality during the use of this package? Send it back upstream! Don't hesitate to submit a pull request! Beyond the brief requirements outlined in the contibuting guide, your imagination represents the only limitation.

License

This project is licensed under the MIT License, an FSF-/OSI-approved and GPL-compatible, permissive free software license. Review the LICENSE file distributed with this source code for additional information.

Additional Links

Purpose Status
Stable Release Packagist
Dev Release Packagist
License License
Reference License