<commit_before># Thredded [![Code Climate](https://codeclimate.com/github/thredded/thredded/badges/gpa.svg)](https://codeclimate.com/github/thredded/thredded) [![Travis-CI](https://api.travis-ci.org/thredded/thredded.svg?branch=master)](https://travis-ci.org/thredded/thredded/) [![Test Coverage](https://codeclimate.com/github/thredded/thredded/badges/coverage.svg)](https://codeclimate.com/github/thredded/thredded/coverage) [![Inline docs](http://inch-ci.org/github/thredded/thredded.svg?branch=master)](http://inch-ci.org/github/thredded/thredded) [![Gitter](https://badges.gitter.im/thredded/thredded.svg)](https://gitter.im/thredded/thredded?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

_Thredded_ is a Rails 4.2+ forum/messageboard engine. Its goal is to be as simple and feature rich as possible.

Some of the features currently in Thredded:

* Markdown (default) or BBCode post formatting.
* (Un)read posts tracking.
* Email notifications, topic subscriptions, @-mentions, per-messageboard notification settings.
* Private group messaging.
* Full-text search using the database.
* Pinned and locked topics.
* List of currently online users, for all forums and per-messageboard.
* Flexible permissions system.
* Basic moderation.
* Lightweight default theme configurable via Sass.

<a href='https://pledgie.com/campaigns/27480'><img alt='Click here to lend your support to: Thredded and make a donation at pledgie.com !' src='https://pledgie.com/campaigns/27480.png?skin_name=chrome' border='0' ></a>

<img src="http://emoji.fileformat.info/gemoji/point_up.png" width="24"> If you are so inclined, donating to the project will help aid in its development

| ![Messageboards (Thredded v0.8.2)](https://cloud.githubusercontent.com/assets/216339/20338810/1fbc4240-abd1-11e6-9cba-4ae2e654c4d4.png) |  ![Topics (Thredded v0.8.2)](https://cloud.githubusercontent.com/assets/216339/20338809/1fbb7dc4-abd1-11e6-9bc3-207b94018931.png) |
|:---:|:---:|
| ![Topic on iPhone 6 (Thredded v0.8.2)](https://cloud.githubusercontent.com/assets/216339/20338433/0920debc-abcf-11e6-811c-8f29d10dfed7.png) | ![Messageboard Preferences on iPhone 6 (Thredded v0.8.2)](https://cloud.githubusercontent.com/assets/216339/20338432/090e9c5c-abcf-11e6-8e7e-e287d31f6a54.png) |

Thredded works with SQLite, MySQL (v5.6.4+), and PostgreSQL. Thredded has no infrastructure
dependencies other than the database and, if configured in the parent application, the ActiveJob
backend dependency such as Redis. Currently only MRI Ruby 2.2+ is supported. We would love to
support JRuby and Rubinius as well.

If you're looking for variations on a theme - see [Discourse]. However, It is a full rails
application and not an engine like Thredded.

[Discourse]: http://www.discourse.org/

* [Installation](#installation)
  * [Creating a new Rails app with Thredded](#creating-a-new-rails-app-with-thredded)
  * [Adding Thredded to an existing Rails app](#adding-thredded-to-an-existing-rails-app)
  * [Upgrading an existing install](#upgrading-an-existing-install)
  * [Migrating from Forem](#migrating-from-forem)
* [Views and other assets](#views-and-other-assets)
  * [Standalone layout](#standalone-layout)
  * [Application layout](#application-layout)
    * [Reference your paths so that Thredded can find them](#reference-your-paths-so-that-thredded-can-find-them)
    * [Add Thredded styles](#add-thredded-styles)
    * [Add Thredded JavaScripts](#add-thredded-javascripts)
      * [jQuery version](#jquery-version)
  * [User profile page](#user-profile-page)
  * [Customizing views](#customizing-views)
    * [View hooks](#view-hooks)
  * [Theming](#theming)
    * [Styles](#styles)
* [Email and other notifications](#email-and-other-notifications)
* [I18n](#i18n)
* [Permissions](#permissions)<commit_msg>Readme: ToC header [ci skip]<commit_after># Thredded [![Code Climate](https://codeclimate.com/github/thredded/thredded/badges/gpa.svg)](https://codeclimate.com/github/thredded/thredded) [![Travis-CI](https://api.travis-ci.org/thredded/thredded.svg?branch=master)](https://travis-ci.org/thredded/thredded/) [![Test Coverage](https://codeclimate.com/github/thredded/thredded/badges/coverage.svg)](https://codeclimate.com/github/thredded/thredded/coverage) [![Inline docs](http://inch-ci.org/github/thredded/thredded.svg?branch=master)](http://inch-ci.org/github/thredded/thredded) [![Gitter](https://badges.gitter.im/thredded/thredded.svg)](https://gitter.im/thredded/thredded?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

_Thredded_ is a Rails 4.2+ forum/messageboard engine. Its goal is to be as simple and feature rich as possible.

Some of the features currently in Thredded:

* Markdown (default) or BBCode post formatting.
* (Un)read posts tracking.
* Email notifications, topic subscriptions, @-mentions, per-messageboard notification settings.
* Private group messaging.
* Full-text search using the database.
* Pinned and locked topics.
* List of currently online users, for all forums and per-messageboard.
* Flexible permissions system.
* Basic moderation.
* Lightweight default theme configurable via Sass.

<a href='https://pledgie.com/campaigns/27480'><img alt='Click here to lend your support to: Thredded and make a donation at pledgie.com !' src='https://pledgie.com/campaigns/27480.png?skin_name=chrome' border='0' ></a>

<img src="http://emoji.fileformat.info/gemoji/point_up.png" width="24"> If you are so inclined, donating to the project will help aid in its development

| ![Messageboards (Thredded v0.8.2)](https://cloud.githubusercontent.com/assets/216339/20338810/1fbc4240-abd1-11e6-9cba-4ae2e654c4d4.png) |  ![Topics (Thredded v0.8.2)](https://cloud.githubusercontent.com/assets/216339/20338809/1fbb7dc4-abd1-11e6-9bc3-207b94018931.png) |
|:---:|:---:|
| ![Topic on iPhone 6 (Thredded v0.8.2)](https://cloud.githubusercontent.com/assets/216339/20338433/0920debc-abcf-11e6-811c-8f29d10dfed7.png) | ![Messageboard Preferences on iPhone 6 (Thredded v0.8.2)](https://cloud.githubusercontent.com/assets/216339/20338432/090e9c5c-abcf-11e6-8e7e-e287d31f6a54.png) |

Thredded works with SQLite, MySQL (v5.6.4+), and PostgreSQL. Thredded has no infrastructure
dependencies other than the database and, if configured in the parent application, the ActiveJob
backend dependency such as Redis. Currently only MRI Ruby 2.2+ is supported. We would love to
support JRuby and Rubinius as well.

If you're looking for variations on a theme - see [Discourse]. However, It is a full rails
application and not an engine like Thredded.

[Discourse]: http://www.discourse.org/

Table of Contents
=================

* [Installation](#installation)
  * [Creating a new Rails app with Thredded](#creating-a-new-rails-app-with-thredded)
  * [Adding Thredded to an existing Rails app](#adding-thredded-to-an-existing-rails-app)
  * [Upgrading an existing install](#upgrading-an-existing-install)
  * [Migrating from Forem](#migrating-from-forem)
* [Views and other assets](#views-and-other-assets)
  * [Standalone layout](#standalone-layout)
  * [Application layout](#application-layout)
    * [Reference your paths so that Thredded can find them](#reference-your-paths-so-that-thredded-can-find-them)
    * [Add Thredded styles](#add-thredded-styles)
    * [Add Thredded JavaScripts](#add-thredded-javascripts)
      * [jQuery version](#jquery-version)
  * [User profile page](#user-profile-page)
  * [Customizing views](#customizing-views)
    * [View hooks](#view-hooks)
  * [Theming](#theming)
    * [Styles](#styles)
* [Email and other notifications](#email-and-other-notifications)
* [I18n](#i18n)
* [Permissions](#permissions)
{'fraction_non_alphanumeric': 0.14435420487293685, 'fraction_numerical': 0.043227665706051875, 'mean_word_length': 5.247954173486089, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 28, 'lorem ipsum': 0, 'www.': 2, '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': '3968936', 'n_tokens_mistral': 2866, 'n_tokens_neox': 2614, 'n_words': 560}