Testing that Tome works properly in a Github pages sub-directory.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
content
files/public
modules
scripts
themes
.gitignore
README.md
composer.json
composer.lock
settings.php

README.md

Composer template for Tome projects

This project is a great place to start for building brand new Tome projects.

There isn't much here now, but keep posted and let me know if anything doesn't work!

Usage

To create a new Tome project, run:

composer create-project drupal-tome/tome-project my_site --stability dev --no-interaction
drush tome:init

To re-install Tome, run:

drush tome:install

To start a local webserver, run:

drush runserver

When you're ready to build your static site, run:

drush tome:static

Symlinks

When composer install or update is ran, the "modules" and "themes" directories, as well as the "settings.php" file, is symlinked into the "web" directory.

This is done to improve DX, but only works on systems that support bash, and symlinks. If you're running Windows you'll probably want to write a custom script to replace symlink.sh, and use the mklink command. Pull requests are welcome to make this functionality cross-platform by default.

Further reading

This project is largely based on drupal-composer/drupal-project, so it's recommended that you consult their README.md for more information.