themes.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. ======
  2. Themes
  3. ======
  4. One of the nice things of django Organice is that themes are handled as separate projects. In fact,
  5. they are pluggable Django apps composed of assets and templates that you can simply install and activate.
  6. Official Themes
  7. ===============
  8. Here is a list of django Organice themes officially supported by us:
  9. #. RSSK Theme: `django-organice-theme-rssk`_
  10. #. Fullpage Theme: `django-organice-theme-fullpage`_
  11. If you have a nice theme and would like to include it in this list `let us know by e-mail`_
  12. or make a pull request on this page of the documentation.
  13. Mother Theme
  14. ------------
  15. ``django-organice-theme`` is the mother of all themes for django Organice. This theme is installed automatically
  16. when you install django Organice. From the development perspective all themes are derived from the mother theme,
  17. which contains a collection of static files (assets) and templates, as well as a ``Makefile`` for asset management.
  18. The mother theme is composed of:
  19. - `bootstrap-sass`_ (Sass version of Twitter Bootstrap v3)
  20. - `Compass`_ (CSS authoring framework using Sass)
  21. - `UglifyJS v2`_ (JavaScript minifier)
  22. The ``Makefile`` also supports you with updating those components on your development system.
  23. Rolling Your Own Theme
  24. ======================
  25. Preparations:
  26. - Visit http://organice.io/themes and find a theme that is as close as it gets of what you want.
  27. - Go to that theme's repository page, make a copy of the whole project, and rename it (e.g. to ``mytheme``).
  28. Loop until you're happy:
  29. - Add or adapt the style sheet (``.scss``), JavaScript (``.js``), and other files in ``mytheme/static/``.
  30. - Run ``make assets`` in order to compile the Sass files to CSS, and combine and minify both CSS und JavaScript.
  31. - Adapt the template files in ``mytheme/templates/``, and test the results on your development system.
  32. .. _`django-organice-theme-rssk`: https://pypi.python.org/pypi/django-organice-theme-rssk
  33. .. _`django-organice-theme-fullpage`: https://pypi.python.org/pypi/django-organice-theme-fullpage
  34. .. _`let us know by e-mail`: support@organice.io
  35. .. _`bootstrap-sass`: https://github.com/twbs/bootstrap-sass
  36. .. _`Compass`: http://compass-style.org/
  37. .. _`UglifyJS v2`: https://github.com/mishoo/UglifyJS2