https://github.com/almarklein/faq-div

Turn any div into a FAQ
https://github.com/almarklein/faq-div

faq faqs knowledge-base websites

Last synced: 8 months ago
JSON representation

Turn any div into a FAQ

• Host: GitHub
• URL: https://github.com/almarklein/faq-div
• Owner: almarklein
• License: gpl-3.0
• Created: 2020-08-25T20:31:18.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-07T21:37:26.000Z (about 2 years ago)
• Last Synced: 2025-01-07T05:28:37.373Z (9 months ago)
• Topics: faq, faqs, knowledge-base, websites
• Language: HTML
• Homepage: https://faq-div.com
• Size: 1.07 MB
• Stars: 6
• Watchers: 4
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

README

          
[![CI](https://github.com/almarklein/faq-div/workflows/CI/badge.svg)](https://github.com/almarklein/faq-div/actions)

![preview](website/img/faqdiv-wide.png)

# FAQ-div - turn any div into a FAQ

FAQ-div is a small JS library that makes it very easy to create effective FAQ pages.

## How?

Write questions in `
` elements, with the answers below.

```html

 Question 1


Answer ...

 Question 2


Answer ...

etc.

```

Add two lines of code. One to load the faq-div lib, and one to mark the start of your FAQ:

```html

...



 Question 1

...

```


Bam! A beautiful FAQ with awesome features! See https://faq-div.com for more info and examples.

## License

### Commercial license

If you want to use FAQ-div to develop non open sourced sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. Which means, you won't have to change your whole application source code to an open source license. You can buy a license [here](https://faq-div.com).

### Open source license

If you are creating an open source application under a license compatible with the GNU GPL license v3, you may use FAQ-div under the terms of the GPLv3.

The credit comments in the JavaScript and CSS files should be kept intact (even after combination or minification).

### Developers

FAQ-div is implemented in vanilla JS. The tooling is mostly in Python

(because I'm primarily a Python dev). Tips:

* `python build.py`: generate `dist/faq-div.min.js`.

* `python build.py develop`: generate `dist/faq-div.min.js` continuously.

* `python serve.py`: build, then start a webserver for website and examples.

* `black .`: autoformat the Python code.

* `flake8 . --max-line-length=89`: linting the Python code.

* I use VS Code plugins to lint the JavaScript and CSS.

* CI lints both Python and JS.