Tidal is a free, open-source, documentation-focused starter kit for Statamic. Tidal is designed for developers who want a simple way to host documentation for their projects using Statamic.
Tidal ships with support for
- Multiple projects: Host documentation for multiple projects from a single Statamic installation
- Multiple project versions: Tidal supports multiple documentation versions per project
The Tidal Multi-site starter kit is intended as starting point for multi-site environment. If you don't need to use Statamic's multi-site feature with Tidal, you should use the Tidal starter kit instead.
How it works
Projects are created and managed from a single "Software Projects" collection; versions can be added to existing projects using the provided utility command. Each version's documentation is managed its own collection, allowing for greater flexibility and organization.
Other bells and whistles
In addition to providing a framework for managing your software projects and documentation, Tidal also ships with the following additional addons configured out-of-the-box:
- Feedamic by Mity Digital: Feedamic is available to help manage your documentation site's RSS and Atom feeds
- Social Media Image Kit by John Koster: A powerful framework to generate social media images for collection entries using Antlers or Blade templates 1
- Site Essentials for Statamic by John Koster: A set of features and utilities to help rapidly develop Statamic web sites 2
- Search Report for Statamic by John Koster: A control panel addon, providing visibility into searches performed by site visitors 3
- Documentation Search by John Koster: A custom search provider for Statamic with a focus on documentation-style websites; capable of indexing individual sections of a Statamic entry 4
- Some Social Media Image Kit features, such as generating images on a queue and preventing duplicate image generation jobs require a database. These features are disabled by default; these features can run on SQLite; your entire site does not need to use a database.. The default HTML to image generator utilizes Spatie's Browsershot library, which requires Puppeteer. Due to the large amount of variability in systems, support for installing, configuring and maintaining Browsershot and Puppeteer is not offered.
- Site Essentials for Statamic provides a favicon generation feature, which is utilized by Tidal. This feature requires Imagick to be available.
- Search Report for Statamic requires a database to store search logs in. This feature is disabled by default. Search Report for Statamic can run on SQLite; your entire site does not need to use a database.
- Documentation Search is a custom search provider with unique templating requirements compared to a typical Statamic search index. These changes have been made within the Tidal starter kit.
Quick start guide
Use the following steps to quickly get Tidal up and running.
First, install Tidal using the Statamic CLI tool:
statamic new mysite Stillat/tidal-multisite
After installation, run the following commands to install and build the front-end assets:
npm run build
Run your project locally your preferred method.
A few quick things for the curious:
- Minimum Statamic version: 4.38
- Minimum PHP version: 8.2
- Front-end build tool: Vite
- Alpine.js version: ^3.13.1
- Tailwind CSS version: ^3.3.2
Tidal is open-source software, released under the GPL-3.0 license.