README

Brought to you by qossmic!

1. Ye be warned!
2. Installation
3. Configuration
   1. Bundle Configuration
   2. Component Configuration
4. Routing
5. Customization
6. Usage

Experimental Package

Important: This is an experimental version and might change drastically. Therefore, you might encounter breaking changes when updating until we release a stable version.

• bad templates: due to the lack of frontend capacities, the templates are very "basic"
  • but as in every Symfony bundle, you can easily overwrite them and create your own :-)
• incomplete documentation
• no translations (yet)

Allows you to create an overview for your Twig Components, be it either UX-Components, UX-Live-Components or simple snippet templates.

Components will be grouped in categories and optional sub-categories.

Installation

As long as the bundle is not publicly released, you need to add a repository to your composer.json file:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/qossmic/twig-doc-bundle.git"
    }
  ]
}

Install the bundle

composer req qossmic/twig-doc-bundle

Routing

As symfony never creates routes for bundles, you need to configure this on your own!

Create a config file: config/routes/twig_doc.yaml

twig_doc:
  resource: '@TwigDocBundle/config/routing/documentation.xml'
  prefix: /twig/doc
  # or for localized: prefix: /{_locale}/twig/doc/

Customizing the design

To customize the design of the documentation, you can override any template of the bundle in your project.

See: How to override any Part of a Bundle