<commit_before># Joofaq

Joofaq is a FAQ page template building gem.  In two easy steps you can have a FAQ page up and running on your rails app with questions and sections easily customizable from a yaml file.

## Installation

Add this line to your application's Gemfile:

    gem 'joofaq'


## Usage

After adding the joofaq gem to your Gemfile, run the joofaq gem generator command:

    rails generate joofaq

This will create a faq.yml file in your db/ directory. To add new sections and questions, follow the format shown in the faq.yml:

   First Category:
   - subtitle: first_category_subtitle_here
   - q: question_1_text_here
     a: answer_1_text_here

Subtitles are optional and you can add as many questions as you need. Remember, this is a yaml file so format (especially indentation) are important for it to work properly.

The generator also created several view files in a new app/views/faq/ directory.  This gives you access to the views so that you can change the styling as you please.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request<commit_msg>Improve readme<commit_after># Joofaq

Joofaq is a FAQ page template building gem.  In two easy steps you can have a FAQ page up and running on your rails app with questions and sections easily customizable from a yaml file.

## Installation

Add this line to your application's Gemfile:

    gem 'joofaq'


## Usage

After adding the joofaq gem to your Gemfile, run the joofaq gem generator command:

    rails generate joofaq

This will create a faq.yml file in your db/ directory. To add new sections and questions, follow the format shown in the faq.yml:

    First Category:
    - subtitle: first_category_subtitle_here
    - q: question_1_text_here
      a: answer_1_text_here

Subtitles are optional and you can add as many questions as you need. Remember, this is a yaml file so format (especially indentation) are important for it to work properly.

The generator also created several view files in a new app/views/faq/ directory.  This gives you access to the views so that you can change the styling as you please.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
{'fraction_non_alphanumeric': 0.05156683855612852, 'fraction_numerical': 0.005553351844506148, 'mean_word_length': 3.79467680608365, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1104296', 'n_tokens_mistral': 741, 'n_tokens_neox': 689, 'n_words': 384}