-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(landing-page): add core and general sections
- Loading branch information
Showing
8 changed files
with
111 additions
and
6 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Base | ||
--- | ||
|
||
{% markdown %} | ||
{% include 'src/core/README.md' %} | ||
{% endmarkdown %} |
This file contains 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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"layout": "basic.njk", | ||
"tags": "core" | ||
} |
This file contains 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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Preview | ||
--- | ||
|
||
{% markdown %} | ||
{% include 'src/core/preview/README.md' %} | ||
{% endmarkdown %} |
This file contains 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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Snippets | ||
--- | ||
|
||
{% markdown %} | ||
{% include 'src/core/snippets/README.md' %} | ||
{% endmarkdown %} |
This file contains 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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"layout": "basic.njk", | ||
"tags": "general" | ||
} |
This file contains 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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Getting started | ||
--- | ||
|
||
{% markdown %} | ||
{% include 'src/README.md' %} | ||
{% endmarkdown %} |
This file contains 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
This file contains 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 |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Installation | ||
|
||
TBD | ||
|
||
# Project structure | ||
|
||
UIP components are organized in the following way: | ||
|
||
1. Core components | ||
- Base components | ||
- [UIPRoot](core/README.md#uip-root) | ||
- [UIPPreview](core/preview/README.md) | ||
- [UIPSnippets](core/snippets/README.md) | ||
2. Plugins | ||
- [UIPEditor](plugins/editor/README.md) | ||
- [UIPOptions](plugins/options/README.md) | ||
- [UIPSettings](plugins/settings/settings/README.md) | ||
- [UIPBoolSetting](plugins/settings/settings/setting/bool-setting/README.md) | ||
- [UIPSelectSetting](plugins/settings/settings/setting/select-setting/README.md) | ||
- [UIPTextSetting](plugins/settings/settings/setting/text-setting/README.md) | ||
|
||
Any playground must have at least **core** components. **Plugins** are | ||
optional, you can add them on your own free will. | ||
|
||
To implement custom UIPPlayground components, see [UIPPlugin](core/README.md#uip-plugin). | ||
|
||
# Modules/components imports | ||
Modules main parts lay inside modules folders. So importing required | ||
module is really straightforward: | ||
|
||
```typescript | ||
import {UIPRoot} from './root'; | ||
import {UIPEditor} from './editor'; | ||
import {UIPBoolSetting} from './bool-setting'; | ||
``` | ||
|
||
Every module has two versions of styles: *css* and *less*. If you want | ||
to import styles for all UIP component, you can import either | ||
*registration.less* or *registration.css* file. | ||
|
||
Before using UIP components, you also need to *register* them. For example, | ||
if you want to use [UIPRoot](src/core/README.md#uip-root) component, register it like that: | ||
|
||
```typescript | ||
import {UIPRoot} from './root'; | ||
UIPRoot.reguster(); | ||
``` | ||
|
||
# Browser support | ||
|
||
UIPPlayground supports all modern browsers. |