denny/ShinyCMS-ruby

# ShinyCMS Documentation

## Using ShinyCMS

### Getting Started

* [tl,dr](tldr.md) - for the impatient :)

* [Installation](INSTALL.md)        - installing a local dev system
* [Configuration](Configuration.md) - where different things are configured
* [External services](Services.md)  - required services and optional extras
* [Demo site](demo-site.md)         - loading the demo site templates and data
* [Themes](Themes.md)               - start building your hosted site by creating a theme for it


### CMS Features

* [User accounts](Features/MainApp/UserAccounts.md)
* [Admin features](Features/MainApp/admin-features.md)

* Basic CMS features
    * [Pages](Features/Plugins/ShinyPages.md)
    * [Inserts](Features/Plugins/ShinyInserts.md)
    * [Form handlers](Features/Plugins/ShinyForms.md)
    * [Search](Features/Plugins/ShinySearch.md)

* Advanced CMS features
    * [Access control](Features/Plugins/ShinyAccess.md)

* Post regular updates
    * [Blog](Features/Plugins/ShinyBlog.md)
    * [News section](Features/Plugins/ShinyNews.md)

* Send promotional emails
    * [Mailing lists](Features/Plugins/ShinyLists.md)
    * [Newsletters](Features/Plugins/ShinyNewsletters.md)

* Build a community
    * [Profile pages](Features/Plugins/ShinyProfiles.md)
    * [Comments](Features/MainApp/Comments.md)
    * [Tags](Features/MainApp/Tags.md)
    * [Upvotes](Features/MainApp/Upvotes.md) ('likes')

* Settings and configuration
    * [Feature flags](Features/MainApp/FeatureFlags.md)
    * [Site settings](Features/MainApp/SiteSettings.md)

* Stats and tracking
    * [Email stats](Features/MainApp/EmailStats.md)
    * [Web stats](Features/MainApp/WebStats.md)
    * [Charts and dashboards](Features/MainApp/Charts.md)

* [MJML email templates](Features/MainApp/mjml.md)

* [Rake tasks](rake-tasks.md)


## Contributing to ShinyCMS (developer documentation)

* [Index](Developers/index.md)

* [Contributing](Contributing.md)

* [Project goals](Developers/ProjectGoals.md)

* Project progress:
    * [Done](Developers/done.md)
    * [In progress](Developers/in-progress.md)
    * [To do](Developers/TODO.md)

* [Plugins](Developers/Plugins.md)
* [Testing](Developers/Testing.md)


## Other

* [Credits](credits.md)

* [Release notes](release-notes.md)

* [Licensing](Licensing/index.md)
    * [GPL v2](Licensing/gnu-gpl-v2.0.md)
    * [GPL v3](Licensing/gnu-gpl-v3.0.md)


## Code of Conduct

This project has a [Code of Conduct](code-of-conduct.md), which is intended
to make using ShinyCMS, or contributing to it, a harassment-free experience for
everybody involved - regardless of who they are and what they do or don't know.

Please read and follow the code of conduct - thank you.