{"repo":"withlogicco/django-prose","free":true,"listed":false,"github":"https://github.com/withlogicco/django-prose","clone":"git clone https://github.com/withlogicco/django-prose.git","description":"Wonderful rich-text editing for your Django project","language":"Python","stars":222,"topics":["django","django-wysiwyg","python","trix","wysiwyg"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Django Prose Django Prose provides your Django applications with wonderful rich-text editing capabilities. Requirements - Python 3.8 or later - Django 3.2 or later - Bleach 4.0 or later Getting started To get started with Django Prose, all you need to do is follow just four steps . 1. Install django-prose We use and suggest using Poetry, although Pipenv and plain pip will work seamlessly as well 2. Add to INSTALLED APPS Add prose in your Django project's installed apps (example: example/example/settings.py ): 3. Run migrations This is required so you can use Django Prose's built-in Document model: 4. Include URLs You need to edit the main urls.py file of your Django project and include prose.urls : Now, you are ready to go 🚀. Usage There are different ways to use Django prose according to your needs. We will examine all of them here. Rendering rich-text in templates Rich text content essentially is HTML. For this reason it needs to be manually marked as safe , when rendered in Django templates. Example: Small rich-text content You might want to add rich-text content in a model that is just a few characters (e.g. 140), like an excerpt from an article. In that case we suggest using the RichTextField . Example: As mentioned above, you need to mark the article excerpt as safe , in order to render it: Large rich-text content In case you want to store large rich-text content, like the body of an article, which can span to quite a few thousand characters, we suggest you use the Abs","default_branch":null,"files":null,"tree":[],"storefront":"/r/withlogicco","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/withlogicco/django-prose/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}