xima/xm_drupal_manual

This module provides a manual for Drupal using the export route of the books core module.

v0.1.3 2024-09-17 13:48 UTC

Requires

• php: ^8.2
• drupal/core: ^10.2

Requires (Dev)

• rector/rector: ^1.1

GPL-2.0-or-later

• Dennis Patzer
• Johann-Georg Nitsche

README

This module provides a manual for Drupal using the export route of the books core module.

The current state is experimental and may contain hard codings.

Features

• templates for displaying a book with all of its pages on a single page
• hides the books outline for non-book-page nodes
• a minimal styling for the manual

Requirements

• Drupal 10+

Installation

1. Install using composer.json: composer require xima/xm_drupal_manual
2. Enable the module in the drupal backend as usual

Developer instructions

PHP quality tools

Rector

A rector config is provided. Run the following command to execute it:

composer run-script php:check

Build assets

Navigate to the module folder in order to rebuild the assets:

Build the minified js:

npm run js

Compile scss into minified css:

npm run sass