tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Enhancement Add documentation for pattern library

Browse Source
This commit is contained in:
Christopher Joe 2017-11-29 14:28:42 +13:00
parent 146be6830b
commit 2dcb3fd2ab
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md
View File

@ -41,7 +41,7 @@ Check our [build tooling](/contributing/build_tooling) docs for more details.
``` ```
(cd framework && yarn run build && yarn run css) cd vendor/silverstripe/admin && yarn build
``` ```
## Coding Conventions ## Coding Conventions
@ -50,6 +50,21 @@ Please follow our [CSS](/contributing/css_coding_conventions)
and [JavaScript](/contributing/javascript_coding_conventions) and [JavaScript](/contributing/javascript_coding_conventions)
coding conventions. coding conventions.
## Pattern library
A pattern library is a collection of user interface design elements, this helps developers and designers collaborate and to provide a quick preview of elements as they were intended without the need to build an entire interface to see it.
Components built in React and used by the CMS are actively being added to the pattern library.
To access the pattern library, starting from your project root:
```
cd vendor/silverstripe/admin && yarn pattern-lib
```
Then browse to `http://localhost:6006/`
## The Admin URL ## The Admin URL
The CMS interface can be accessed by default through the `admin/` URL. You can change this by setting your own [Director routing rule](director#routing-rules) to the `[AdminRootController](api:SilverStripe\Admin\AdminRootController)` and clear the old rule like in the example below. The CMS interface can be accessed by default through the `admin/` URL. You can change this by setting your own [Director routing rule](director#routing-rules) to the `[AdminRootController](api:SilverStripe\Admin\AdminRootController)` and clear the old rule like in the example below.