Skip to content

Commit 8d4b6eb

Browse files
committed
Add links to new demo site
1 parent 3179110 commit 8d4b6eb

File tree

4 files changed

+18
-1
lines changed

4 files changed

+18
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![PyPI](https://img.shields.io/pypi/v/django-pattern-library.svg)](https://pypi.org/project/django-pattern-library/) [![PyPI downloads](https://img.shields.io/pypi/dm/django-pattern-library.svg)](https://pypi.org/project/django-pattern-library/) [![Travis](https://travis-ci.com/torchbox/django-pattern-library.svg?branch=master)](https://travis-ci.com/torchbox/django-pattern-library) [![Total alerts](https://img.shields.io/lgtm/alerts/g/torchbox/django-pattern-library.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/torchbox/django-pattern-library/alerts/)
44

5-
> UI pattern libraries for Django templates
5+
> UI pattern libraries for Django templates. Try our [online demo](https://torchbox.github.io/django-pattern-library/demo/pattern-library/).
66
77
![Screenshot of the pattern library UI, with navigation, pattern rendering, and configuration](https://raw.githubusercontent.com/torchbox/django-pattern-library/master/.github/pattern-library-screenshot.webp)
88

@@ -27,6 +27,13 @@ Pattern libraries will change your workflow for the better:
2727

2828
Learn more by watching our presentation – [Reusable UI components: A journey from React to Wagtail](https://www.youtube.com/watch?v=isrOufI7TKc).
2929

30+
## Online demo
31+
32+
The pattern library is dependent on Django for rendering – but also supports exporting as a static site if needed. Try out our online demo:
33+
34+
- For a component, [accordion.html](https://torchbox.github.io/django-pattern-library/demo/pattern-library/pattern/patterns/molecules/accordion/accordion.html)
35+
- For a page-level template, [person_page.html](https://torchbox.github.io/django-pattern-library/demo/pattern-library/pattern/patterns/pages/people/person_page.html)
36+
3037
## Documentation
3138

3239
Documentation is available at [torchbox.github.io/django-pattern-library](https://torchbox.github.io/django-pattern-library/), with source files in the `docs` directory.

docs/getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Getting started
22

3+
> If you just want to see django-pattern-library up and running, have a look at our [online demo](https://torchbox.github.io/django-pattern-library/demo/pattern-library/pattern/patterns/molecules/accordion/accordion.html).
4+
35
## Installation
46

57
django-pattern-library is available [on PyPI](https://pypi.org/project/django-pattern-library/). First install it in your Django project:

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ Pattern libraries will change your workflow for the better:
2525
- They encourage code reuse – defining independent UI components, that can be reused across apps, or ported to other projects.
2626
- It makes it much simpler to test UI components – no need to figure out where they’re used across a site or app.
2727

28+
## Online demo
29+
30+
The pattern library is dependent on Django for rendering – but also supports exporting as a static site if needed. Try out our online demo:
31+
32+
- For a component, [accordion.html](https://torchbox.github.io/django-pattern-library/demo/pattern-library/pattern/patterns/molecules/accordion/accordion.html)
33+
- For a page-level template, [person_page.html](https://torchbox.github.io/django-pattern-library/demo/pattern-library/pattern/patterns/pages/people/person_page.html)
34+
2835
## Why this exists
2936

3037
We want to make it possible for developers to maintain large pattern libraries with minimal fuss – no copy-pasting of templates between a static library and the “production” templates.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,4 @@ nav:
5050
- 'Concepts': 'reference/concepts.md'
5151
- 'Known issues': 'reference/known-issues.md'
5252
- 'Related projects': 'reference/related-projects.md'
53+
- 'Online demo': '/django-pattern-library/demo/pattern-library/'

0 commit comments

Comments
 (0)