-
Notifications
You must be signed in to change notification settings - Fork 1
Docs/installing and configuring #49
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,49 @@ | ||
| # 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: ~ | ||
| javascripts: [] | ||
| stylesheets: [] | ||
| 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: '<p>This is the icon card component description.</p>' | ||
| renderer: | ||
| type: homepage | ||
| options: | ||
| sections: [] | ||
| ``` | ||
|
|
||
| Install assets | ||
| ```bash | ||
| $ bin/console assets:install --symlink | ||
| ``` | ||
|
|
||
| Now you can navigate to `http://localhost:8000/design-system` and see the index page. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: '<p>This is the button atom description.</p>' | ||
| 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: '<p>This is the icon card component description.</p>' | ||
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,18 @@ | ||
| # 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: ~ | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing javascripts and stylesheets parameters |
||
| # 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" | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing
javascriptsandstylesheetsparameters