Tome
Tome is a static site generator and storage system for Drupal content and configuration. It automatically syncs changes to your local filesystem, allowing you to rebuild your site without a database. You can then generate a static HTML version of your site, similar to using tools like Jekyll or Hugo, with Drupal only needed for local development.
Tome is a static site generator, and a static storage system for content.
When Tome is enabled, any changes to config, content, or files will be automatically synced to your local filesystem. These exports can be used to fully rebuild the site from scratch, which removes the need for a persistent SQL database or filesystem. When you're ready to push to production, you can use Tome to generate a static HTML version of your site.
Long story short, you can use Drupal in the same way you would use other static site generators like Jekyll or Hugo - everything lives in one repository, and Drupal only runs on your local machine.
Feature highlights
- Generate a static site only using Drupal (no JavaScript required!)
- Store content in Git and only use Drupal when you need it
- Static builds are always partial and cached by default
- All commands scale using a combination of concurrency and batching
- Views pagers and Media OEmbeds work out of the box
Requirements
- Drupal 8/9
- PHP 7
- Drush 9+
Starting a new project
If you want to create a new Tome project, please follow the guide at https://tome.fyi/docs/getting-started. This will take you through initializing your codebase, Drupal install, and Tome export.
Installing to existing project
Please follow the guide at https://tome.fyi/docs/installing-existing-site/, for just using Tome Static or migrating to Tome.
Hosting guides
If you're interested in how hosting on services like Github Pages, Netlify, Render, or a traditional host like Pantheon or Acquia would work, check out the "Hosting Guides" documentation at https://tome.fyi/docs/.
Using sub-modules
Tome is split up into two-submodules that can be used individually.
If you just want to generate a static site, enable Tome Static. If you just want to store your content and config in Git, enable Tome Sync. If you want both, enable Tome!
For more information see https://tome.fyi/docs/sub-modules/
Other notes
Please visit http://tome.fyi/ for the most up to date documentation for this module. The site is also made with Tome and is open source: https://github.com/drupal-tome/drupal-tome.github.io