index.rst 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. Wagtail CRX Documentation
  2. =========================
  3. `Official website <https://www.coderedcorp.com/cms/>`_ | `Source code on GitHub <https://github.com/coderedcorp/wagtailcrx>`_
  4. Formerly known as CodeRed CMS, Wagtail CRX (short for Wagtail + CodeRed
  5. Extensions), provides a large set of enhancements and pre-built components for
  6. Wagtail which are ready to use out-of-the box. This saves development time and
  7. avoids "re-inventing the wheel" by providing features commonly needed by
  8. websites:
  9. * Streamfield blocks and templates for Bootstrap 4: rows, columns, hero units,
  10. carousels, buttons, modals, cards, and more!
  11. * Settings for adding logo, navigation, footer, and other common elements.
  12. * Rich set of SEO tagging attributes on each page.
  13. * Configurable Google Analytics tracking.
  14. * Robust form builder including the ability for multi-step forms, conditional
  15. logic, customized confirmation emails, MailChimp integration, and more (all
  16. from within the streamfield!)
  17. * Article pages for building blogs, news, etc.
  18. * Calendar and event pages.
  19. * Google Maps blocks, and store locator functionality.
  20. * Dynamic classifier system, for creating filterable categories.
  21. * Website search functionality, filterable by page type.
  22. * Style your site using SASS/SCSS directly from Django, without the need for
  23. Node.js
  24. Wagtail CRX is "just" Wagtail
  25. -----------------------------
  26. An important line of distinction is that Wagtail CRX is not a fork of Wagtail,
  27. or a competing version of Wagtail. It is simply a pip package which provides
  28. additional features on top of stock Wagtail you know and love.
  29. CRX is to Wagtail, what Wagtail is to Django. A set of additional features for
  30. web developers to save time and turn out high-quality websites. CRX is not a
  31. drag-n-drop or no-code solution (although many of the features do not require
  32. coding).
  33. Our motivation for making Wagtail CRX is to enable a developer to quickly build
  34. a Wagtail website by pulling in pre-built components which have been heavily
  35. tested and are guaranteed to work in a consistent way. This is why the project
  36. is tightly coupled with Bootstrap CSS. This is a boon for web development teams:
  37. rather than copy-pasting code from one project to the next, code is centralized
  38. in a generic way in CRX and can be reused by many sites. This also helps
  39. with maintenance and Wagtail upgrades --- bugs and upgrades can generally be
  40. implemented once in CRX then pushed out to all sites.
  41. Join us
  42. -------
  43. Have questions or ideas? Join us in the **#wagtailcrx** channel on the
  44. `Wagtail Slack <https://wagtail.io/slack/>`_.
  45. Contents
  46. --------
  47. .. toctree::
  48. :maxdepth: 2
  49. :titlesonly:
  50. getting_started/index
  51. advanced/index
  52. features/index
  53. how_to/index
  54. reference/index
  55. contributing/index
  56. releases/index