From 33ebc5efd41e8bd35a933f62194069844161188d Mon Sep 17 00:00:00 2001 From: Aitor Brazaola Date: Mon, 18 Sep 2017 12:00:07 +0200 Subject: [PATCH 1/4] Added Installing and Configuring documentation. --- docs/first_use_installing_and_configuring.md | 47 +++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/docs/first_use_installing_and_configuring.md b/docs/first_use_installing_and_configuring.md index 2a16c9f..194586d 100644 --- a/docs/first_use_installing_and_configuring.md +++ b/docs/first_use_installing_and_configuring.md @@ -1,3 +1,48 @@ # Installing and configuring -> TODO +The easiest way to install this bundle is using Composer +```bash +$ composer require lin3s/pattern-library-builder +``` +Register the Bundle in your AppKernel +```php +$bundles = [ + ... + new Lin3sPatternLibraryBuilderBundle(), + ... +]; +``` +Configure the basic settings in your `config.yml`: +```yaml +lin3s_pattern_library_builder: + theme: + title: "My title" + description: "My description" + custom_styles: + color_primary: "#000" + logo: ~ + templates_config_files_path: "%kernel.root_dir%/PatternLibrary" +``` +Add routes to access the Design System in your routing file: +```yaml +_pattern_library: + resource: "@Lin3sPatternLibraryBuilderBundle/Resources/config/routing.yml" +``` +Create a folder in your AppBundle kernel root named `PatternLibrary` to store the Pattern Library configuration +and create an index configuration file. +```yaml +status: 0 +description: '

This is the icon card component description.

' +renderer: + type: homepage + options: + sections: [] +``` +Create a folder in your project's root named `templates` with the different subfolders of templates you want to have. + +Install assets +```bash +$ bin/console assets:install --symlink +``` + +Now you can navigate to `http://localhost:8000/design-system` and see the index page. From bff7b123f2795d524bad0d40218ad98a4f674ea9 Mon Sep 17 00:00:00 2001 From: Aitor Brazaola Date: Mon, 18 Sep 2017 12:46:01 +0200 Subject: [PATCH 2/4] Updated First use and Installing and configuring docs. --- docs/first_use_installing_and_configuring.md | 1 - docs/first_use_your_first_page.md | 40 +++++++++++++++++++- 2 files changed, 39 insertions(+), 2 deletions(-) diff --git a/docs/first_use_installing_and_configuring.md b/docs/first_use_installing_and_configuring.md index 194586d..2b3fa29 100644 --- a/docs/first_use_installing_and_configuring.md +++ b/docs/first_use_installing_and_configuring.md @@ -38,7 +38,6 @@ renderer: options: sections: [] ``` -Create a folder in your project's root named `templates` with the different subfolders of templates you want to have. Install assets ```bash diff --git a/docs/first_use_your_first_page.md b/docs/first_use_your_first_page.md index c695fff..d481b1b 100644 --- a/docs/first_use_your_first_page.md +++ b/docs/first_use_your_first_page.md @@ -1,3 +1,41 @@ # Your first page -For this example we are showing +For rendering components in the Pattern Library first you should create a YAML in your `PatternLibrary` folder for the +desired item to render. It is recommended to have separated folders inside PatternLibrary folder for separating +different kind of components. + +For example: +```yaml +status: 2 +description: '

This is the button atom description.

' +renderer: + type: twig + options: + template: 'atoms/button.html.twig' + preview_parameters: + primary: + content: Hola + link: + content: Hola 2 + modifier: orange + href: test + tag: a +``` + +Then, reference it in `index.yml` on the desired section with the corresponding slug based on directory structure: +```yaml +status: 0 +description: '

This is the icon card component description.

' +renderer: + type: homepage + options: + sections: + - + title: 'Atoms' + description: 'These are the atoms' + items: + - + slug: 'architecture/atoms/button' +``` + +The component to render must exists in the current views folder of your application. From c86c89757031fddfe4a6f6958af2df7ac3907b89 Mon Sep 17 00:00:00 2001 From: Aitor Brazaola Date: Mon, 18 Sep 2017 12:57:23 +0200 Subject: [PATCH 3/4] Updated Symfony Parameters Reference --- docs/symfony_configuration_reference.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/symfony_configuration_reference.md b/docs/symfony_configuration_reference.md index db0f495..f627716 100644 --- a/docs/symfony_configuration_reference.md +++ b/docs/symfony_configuration_reference.md @@ -1,3 +1,14 @@ # Symfony Configuration reference -> TODO +These are the parameters accepted by Pattern Library Builder + +```yaml +lin3s_pattern_library_builder: + theme: + title: "My title" + description: "My description" + custom_styles: + color_primary: "#000" + logo: ~ + templates_config_files_path: "%kernel.root_dir%/PatternLibrary" +``` From 6c2becf395d7661296a0f557ca4484deed4ba27b Mon Sep 17 00:00:00 2001 From: gorkalaucirica Date: Fri, 6 Oct 2017 14:23:26 +0200 Subject: [PATCH 4/4] Added missing configuration reference items to docs --- docs/first_use_installing_and_configuring.md | 2 ++ docs/symfony_configuration_reference.md | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/docs/first_use_installing_and_configuring.md b/docs/first_use_installing_and_configuring.md index 2b3fa29..c89473a 100644 --- a/docs/first_use_installing_and_configuring.md +++ b/docs/first_use_installing_and_configuring.md @@ -21,6 +21,8 @@ lin3s_pattern_library_builder: custom_styles: color_primary: "#000" logo: ~ + javascripts: [] + stylesheets: [] templates_config_files_path: "%kernel.root_dir%/PatternLibrary" ``` Add routes to access the Design System in your routing file: diff --git a/docs/symfony_configuration_reference.md b/docs/symfony_configuration_reference.md index f627716..525e6a6 100644 --- a/docs/symfony_configuration_reference.md +++ b/docs/symfony_configuration_reference.md @@ -10,5 +10,9 @@ lin3s_pattern_library_builder: custom_styles: color_primary: "#000" logo: ~ + # Javascript files to be injected to the pattern library + javascripts: [] + # CSS files to be injected to the pattern library + stylesheets: [] templates_config_files_path: "%kernel.root_dir%/PatternLibrary" ```