Reference manual

A comprehensive list of features and settings included in Trek.

Generators

• Installer — bin/rails g trek:install
• Admin user — bin/rails g trek:admin:user
• Scaffold — bin/rails g trek:scaffold
• Taxonomies — bin/rails g trek:taxonomies
• Audit log — bin/rails g trek:audit_log
• Public accounts — bin/rails g trek:public_accounts
• Security headers — bin/rails g trek:install:security_headers
• Deploying to Scalingo — bin/rails g trek:scalingo
• bin/rails g trek:upgrade:v2 — upgrades to Trek 2.0: moves the gem and the npm package from the private GitLab sources to RubyGems and npmjs.com

Models

Generated into your application — they're yours to read and modify.

• Page, PageVersion, PagePath
• Fragment
• MenuNode, ExternalLink
• User (and its deprecated session form model)
• Tag, TagCategory & Tagging (with the taxonomies generator)
• Current

Concerns

Trek's behaviors, packaged as concerns you can mix into any model:

• Content: Contentable, Fragmentable, Sectionable, Formattable
• I18n & URLs: Translatable, Sluggable, Pathable
• Pages: Pageable, Versionable, SearchEngineOptimizable
• Utilities: Orderable, Keyable, Searchable, Taggable, Phonable

Back-office

• Controllers — Trek::BaseController, Trek::ResourceController, panels
• Forms — Trek::FormBuilder and its custom helpers
• Formatters — typography & ProseMirror-to-HTML pipeline
• Policies — ActionPolicy integration
• Uploaders — Shrine-based attachments
• Validators — disposable email addresses, email format, phone numbers…, for any model

Front-end

• Components — the ViewComponents powering the admin UI
• Icons — the bundled SVG icon set

Configuration

• Environment variables