DEV Community

Cover image for DjangoCMS FAQ
Corentin Bettiol
Corentin Bettiol

Posted on • Edited on

DjangoCMS FAQ

My company released a cool open-source plugin named DjangoCMS FAQ that you can use in your websites a few weeks ago, let me describe it:

Install

The project is on pypi, so just use pip!

python3 -m pip install djangocms-faq
Enter fullscreen mode Exit fullscreen mode

Features

FAQ Plugins

  • Create a FaqContainer Plugin that have a name, and can only contain FaqQuestion Plugins that have a name (the question) and keywords!
  • Create answers as TextPlugin, ImagePlugin or VideoPlugin inside the FaqQuestion Plugins (this can be easily extended using the settings of your project)!
  • Here's a small gif (better video here in the readme): create faq containers, questions & answers

FAQ Search Plugin

  • Create a FaqSearchPlugin that have a name, select all the FaqContainers that this instance will search into, and put it on any page on your site!
  • Here's a small gif (better video here in the readme): create faq search plugin & search into

Settings

  • If you don't need the FaqSearch you can set the DJANGOCMS_FAQ_ENABLE_API variable to False in your settings.
  • You can add as many Plugins as you want in the FaqQuestion plugins using the DJANGOCMS_FAQ_ANSWER_PLUGINS list in your settings.
  • If you don't wanna show the keywords in the questions, just put this var to False: DJANGOCMS_FAQ_SHOW_KEYWORDS_QUESTION.
  • And if you don't want to show the keywords in the FaqSearch Plugin answers then put this to False in your settings : DJANGOCMS_FAQ_SHOW_KEYWORDS_ANSWER.

Image of Timescale

Timescale – the developer's data platform for modern apps, built on PostgreSQL

Timescale Cloud is PostgreSQL optimized for speed, scale, and performance. Over 3 million IoT, AI, crypto, and dev tool apps are powered by Timescale. Try it free today! No credit card required.

Try free

Top comments (0)

AWS Security LIVE!

Tune in for AWS Security LIVE!

Join AWS Security LIVE! for expert insights and actionable tips to protect your organization and keep security teams prepared.

Learn More

👋 Kindness is contagious

Dive into an ocean of knowledge with this thought-provoking post, revered deeply within the supportive DEV Community. Developers of all levels are welcome to join and enhance our collective intelligence.

Saying a simple "thank you" can brighten someone's day. Share your gratitude in the comments below!

On DEV, sharing ideas eases our path and fortifies our community connections. Found this helpful? Sending a quick thanks to the author can be profoundly valued.

Okay