diff --git a/.github/assets/lookbook_ui.png b/.github/assets/lookbook_ui.png new file mode 100644 index 0000000..6a30772 Binary files /dev/null and b/.github/assets/lookbook_ui.png differ diff --git a/README.md b/README.md index 7e59600..188dc73 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ -# README +
+ +

Django Lookbook

+ +

Empower your Django development with this pluggable app for creating a robust component library. Includes preview system, documentation engine, and parameter editor for building modular UI effortlessly.

+ +

Documentation  |  Demo site

+ +

Pypi version +CI status

+ +
+ +![Django Lookbook UI](.github/assets/lookbook_ui.png) diff --git a/docs/source/conf.py b/docs/source/conf.py index c351ee4..852b9f7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -61,3 +61,16 @@ def _get_version() -> str: # html_static_path = ['_static'] html_theme = "furo" pygments_style = "sphinx" + +announcement_html = """ +
+ Have questions, feedback, or just want to chat? Reach out to me on + + Twitter / X + +
+""" + +html_theme_options = { + "announcement": announcement_html, +} diff --git a/docs/source/install.md b/docs/source/install.md index af7aadb..282629a 100644 --- a/docs/source/install.md +++ b/docs/source/install.md @@ -97,7 +97,7 @@ Each time we visit a preview, the method would be called and the final result wo ## Override Template -In some cases, you might need to render HTML code which need work with CSS and JS. You can override the `preview` template to include them. +In some cases, you might need to render HTML code which need work with your own CSS and JS. You can override the `preview` template to include them. Create *django_viewcomponent/preview.html* in the project `templates` directory