Add build-configs.yaml

Signed-off-by: Oliver Davies <oliver@oliverdavies.uk>

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Move source files into an `src` directory.
+51c5f5759d667821fc94b9ed170de9a43dfbc848

.gitignore

@@ -1,18 +1,8 @@
-/.phpunit.result.cache
+# Nix.
-/output_*/
-/vendor/
-
 /.direnv/
+/result
 
-/source/build/*
+# pdfpc.
-!/source/build/.keep
+/**/*.pdfpc
 
-# Devenv
+/**/*.pdf
-.devenv*
-devenv.local.nix
-
-# direnv
-.direnv
-
-# pre-commit
-.pre-commit-config.yaml

.nvim.lua

@@ -0,0 +1,5 @@
+vim.keymap.set("n", "<leader>ta", '_iTextAnnotation "<Esc>A"<Esc>j')
+vim.keymap.set("v", "<leader>ta", ':norm ITextAnnotation "<Esc>gv:norm A"<Esc>')
+
+vim.keymap.set("n", "<Left>", "gT")
+vim.keymap.set("n", "<Right>", "gt")

README.rst

@@ -0,0 +1,4 @@
+Talks and Presentations by Oliver Davies
+########################################
+
+The source files for `my presentation slides <https://www.oliverdavies.uk/presentations>`_, written in reStructuredText and compiled using `rst2pdf <https://rst2pdf.org>`_.

building-build-configs/sections/conclusion.rst

@@ -0,0 +1,27 @@
+.. raw:: pdf
+
+   PageBreak standardPage
+
+Result
+======
+
+- Easier and faster to create and onboard projects.
+- One canonical source of truth.
+- Easy to add new features and fixes for all projects.
+- Automation is easier due to consistency (e.g. Docker Compose service names).
+
+Thanks!
+=======
+
+References:
+
+- https://opdavi.es/build-configs
+- https://github.com/opdavies/docker-example-drupal
+- https://github.com/opdavies/docker-example-drupal-commerce-kickstart
+- https://github.com/opdavies/docker-example-drupal-localgov
+
+|
+
+Me:
+
+- https://www.oliverdavies.uk

building-build-configs/sections/customisation.rst

@@ -0,0 +1,52 @@
+.. raw:: pdf
+
+   PageBreak standardPage
+
+Overriding Values
+=================
+
+.. code-block:: yaml
+
+   php:
+     version: 8.1-fpm-bullseye
+     # Disable PHPCS, PHPStan and PHPUnit.
+     phpcs: false
+     phpstan: false
+     phpunit: false
+
+   # Ignore more directories from Git.
+   git:
+     ignore:
+       - /bin/
+       - /libraries/
+       - /web/profiles/contrib/
+
+.. raw:: pdf
+
+   TextAnnotation "Drupal Commerce Kickstart demo. No custom modules to test, and additional paths to ignore from Git."
+
+   PageBreak
+
+.. code-block:: yaml
+
+   dockerfile:
+     stages:
+       build:
+         # What additional directories do we need?
+         extra_directories:
+           - config
+           - patches
+           - scripts
+
+         commands:
+           - composer validate --strict
+           - composer install
+
+         # What additional PHP extensions do we need?
+         extensions:
+           install: [bcmath]
+
+.. raw:: pdf
+
+   TextAnnotation "Extra directories and PHP extensions that need to be added".
+

building-build-configs/sections/example.rst

@@ -0,0 +1,92 @@
+Example
+=======
+
+build.yaml:
+
+.. code-block:: yaml
+
+   name: my-example-project
+   type: drupal
+   language: php
+
+   php:
+     version: 8.1-fpm-bullseye
+
+|
+
+Dockerfile:
+
+.. raw:: pdf
+
+   TextAnnotation "Abstract the project-specific values and configuration into this file."
+
+.. code-block:: yaml
+
+   FROM php:8.1-fpm-bullseye AS base
+
+Configuring a Project
+=====================
+
+.. code-block:: yaml
+
+   php:
+     version: 8.1-fpm-bullseye
+
+     # Which PHPCS standards should be used and on which paths?
+     phpcs:
+       paths: [web/modules/custom]
+       standards: [Drupal, DrupalPractice]
+
+     # What level should PHPStan run and on what paths?
+     phpstan:
+       level: max
+       paths: [web/modules/custom]
+
+.. raw:: pdf
+
+   PageBreak
+
+.. code-block:: yaml
+
+   docker-compose:
+     # Which Docker Compose services do we need?
+     services:
+       - database
+       - php
+       - web
+
+   dockerfile:
+     stages:
+       build:
+         # What commands do we need to run?
+         commands:
+           - composer validate --strict
+           - composer install
+
+.. raw:: pdf
+
+   PageBreak
+
+.. code-block:: yaml
+
+   web:
+     type: nginx # nginx, apache, caddy
+
+   database:
+     type: mariadb # mariadb, mysql
+     version: 10
+
+   # Where is Drupal located?
+   drupal:
+     docroot: web # web, docroot, null
+
+   experimental:
+     createGitHubActionsConfiguration: true
+     runGitHooksBeforePush: true
+     useNewDatabaseCredentials: true
+
+.. raw:: pdf
+
+  TextAnnotation "Experimental opt-in features that I want to trial on certain projects or to disable non-applicable features - e.g. GitHub Actions on Bitbucket."
+
+  PageBreak

building-build-configs/sections/internals.rst

@@ -0,0 +1,300 @@
+.. raw:: pdf
+
+   PageBreak titlePage
+
+.. class:: centredtitle
+
+Build Configs internals
+
+.. raw:: pdf
+
+   PageBreak standardPage
+
+.. code-block::
+
+   src/
+       Action/
+           CreateFinalConfigurationData.php
+           CreateListOfFilesToGenerate.php
+           GenerateConfigurationFiles.php
+           ValidateConfigurationData.php
+       Command/
+           GenerateCommand.php
+           InitCommand.php
+       DataTransferObject/
+           ConfigDto.php
+           TemplateFile.php
+       Enum/
+           Language.php
+           ProjectType.php
+           WebServer.php
+
+.. code-block:: php
+   :linenos:
+   :startinline: true
+
+   protected function configure(): void
+       $this
+           ->addOption(
+               name: 'config-file',
+               shortcut: ['c'],
+               mode: InputOption::VALUE_REQUIRED,
+               description: 'The path to the project\'s build.yaml file',
+               default: 'build.yaml',
+           )
+           ->addOption(
+               name: 'output-dir',
+               shortcut: ['o'],
+               mode: InputOption::VALUE_REQUIRED,
+               description: 'The directory to create files in',
+               default: '.',
+           );
+   }
+
+.. code-block:: php
+   :linenos:
+   :startinline: true
+
+   protected function execute(InputInterface $input, OutputInterface $output): int
+   {
+      $io = new SymfonyStyle($input, $output);
+
+      $configFile = $input->getOption(name: 'config-file');
+      $outputDir = $input->getOption(name: 'output-dir');
+   }
+
+.. raw:: pdf
+
+   PageBreak
+
+.. code-block:: php
+   :linenos:
+   :startinline: true
+
+   protected function execute(InputInterface $input, OutputInterface $output): int
+   {
+      // ...
+
+      $pipelines = [
+          new CreateFinalConfigurationData(),
+ 
+          new ValidateConfigurationData(),
+ 
+          new CreateListOfFilesToGenerate(),
+ 
+          new GenerateConfigurationFiles(
+              $this->filesystem,
+              $this->twig,
+              $outputDir,
+          ),
+      ];
+    }
+
+.. code-block:: php
+   :linenos:
+   :startinline: true
+
+   protected function execute(InputInterface $input, OutputInterface $output): int
+   {
+       // ...
+
+       /**
+        * @var Collection<int,TemplateFile> $generatedFiles
+        * @var ConfigDto $configurationData
+        */
+       [$configurationData, $generatedFiles] = (new Pipeline())
+           ->send($configFile)
+           ->through($pipelines)
+           ->thenReturn();
+
+       $io->info("Building configuration for {$configurationData->name}.");
+
+       $io->write('Generated files:');
+       $io->listing(static::getListOfFiles(filesToGenerate: $generatedFiles)->toArray());
+
+       return Command::SUCCESS;
+   }
+
+.. code-block:: php
+   :linenos:
+   :startinline: true
+
+   // CreateFinalConfigurationData.php
+
+   public function handle(string $configFile, \Closure $next) {
+   {
+       $configurationData = Yaml::parseFile(filename: $configFile);
+
+       $configurationData = array_replace_recursive(
+           Yaml::parseFile(filename: __DIR__ . '/../../resources/build.defaults.yaml'),
+           $configurationData,
+       );
+
+       // ...
+
+       return $next($configurationData);
+   }
+
+.. raw:: pdf
+
+   PageBreak
+
+.. code-block:: php
+   :linenos:
+   :startinline: true
+
+   // ValidateConfigurationData.php
+
+   public function handle(array $configurationData, \Closure $next)
+   {
+       // Convert the input to a configuration data object.
+       $normalizer = new ObjectNormalizer(null, new CamelCaseToSnakeCaseNameConverter());
+       $serializer = new Serializer([$normalizer], [new JsonEncoder()]);
+
+       $configurationDataDto = $serializer->deserialize(
+           json_encode($configurationData),
+           ConfigDto::class,
+           'json',
+       );
+
+       // ...
+   }
+
+.. raw:: pdf
+
+   PageBreak
+
+.. code-block:: php
+   :linenos:
+   :startinline: true
+
+   // ValidateConfigurationData.php
+
+   public function handle(array $configurationData, \Closure $next)
+   {
+       // ...
+
+       $validator = Validation::createValidatorBuilder()
+           ->enableAnnotationMapping()
+           ->getValidator();
+       $violations = $validator->validate($configurationDataDto);
+
+       if (0 < $violations->count()) {
+           throw new \RuntimeException('Configuration is invalid.');
+       }
+
+       return $next([$configurationData, $configurationDataDto]);
+   }
+
+.. code-block:: php
+   :linenos:
+   :startinline: true
+
+   // ConfigDto.php
+
+   #[Assert\Collection(
+        allowExtraFields: false,
+        fields: ['docroot' => new Assert\Choice([null, 'web', 'docroot'])],
+    )]
+    public array $drupal;
+
+    #[Assert\Collection([
+        'ignore' => new Assert\Optional([
+            new Assert\All([
+                new Assert\Type('string'),
+            ]),
+        ]),
+    ])]
+    public array $git;
+
+    #[Assert\Choice(choices: ['javascript', 'php', 'typescript'])]
+    public string $language;
+
+    #[Assert\NotBlank]
+    #[Assert\Type('string')]
+    public string $name;
+
+    #[Assert\Type('string')]
+    public string $projectRoot;
+
+    #[Assert\Choice(choices: [
+        'drupal',
+        'fractal',
+        'php-library',
+        'symfony',
+   ])]
+   public string $type;
+
+.. code-block:: php
+   :startinline: true
+   :linenos:
+
+   // CreateListOfFilesToGenerate.php
+
+   public function handle(array $configurationDataAndDto, \Closure $next)
+   {
+       /**
+         * @var ConfigDto $configDto,
+         * @var array<string,mixed> $configurationData
+         */
+        [$configurationData, $configDto] = $configurationDataAndDto;
+
+        /** @var Collection<int, TemplateFile> */
+        $filesToGenerate = collect();
+
+        // ...
+   }
+
+.. code-block:: php
+   :startinline: true
+   :linenos:
+
+   // CreateListOfFilesToGenerate.php
+
+   public function handle(array $configurationDataAndDto, \Closure $next)
+   {
+       // ...
+
+       if (!isset($configDto->php['phpunit']) || $configDto->php['phpunit'] !== false) {
+
+           $filesToGenerate->push(
+               new TemplateFile(
+                   data: 'drupal/phpunit.xml.dist',
+                   name: 'phpunit.xml.dist',
+               )
+           );
+       }
+
+       // ...
+
+       return $next([$configurationData, $configDto, $filesToGenerate]);
+   }
+
+.. code-block:: php
+   :linenos:
+   :startinline: true
+
+   // GenerateConfigurationFiles.php
+
+   public function handle(array $filesToGenerateAndConfigurationData, \Closure $next)
+   {
+       // ...
+
+       $filesToGenerate->each(function(TemplateFile $templateFile) use ($configurationData): void {
+           if ($templateFile->path !== null) {
+               if (!$this->filesystem->exists($templateFile->path)) {
+                   $this->filesystem->mkdir("{$this->outputDir}/{$templateFile->path}");
+               }
+           }
+
+           $sourceFile = "{$templateFile->data}.twig";
+
+           $outputFile = collect([$this->outputDir, $templateFile->path, $templateFile->name])
+               ->filter()->implode('/');
+
+           $this->filesystem->dumpFile($outputFile, $this->twig->render($sourceFile, $configurationData));
+       });
+
+       return $next([$configurationDataDto, $filesToGenerate]);
+   }
+

building-build-configs/sections/intro.rst

@@ -0,0 +1,55 @@
+.. raw:: pdf
+
+   PageBreak standardPage
+
+What is "Build Configs"?
+========================
+
+- Command-line tool.
+- Inspired by Workspace, name from the TheAltF4Stream.
+- Built with Symfony.
+- Creates and manages build configuration files.
+- Customisable per-project.
+- Drupal, PHP library, Fractal (TypeScript).
+- "Sprint zero in a box".
+
+What Problem Does it Solve?
+===========================
+
+- I work on multiple similar projects.
+- Different configuration values - e.g. ``web`` vs. ``docroot``.
+- Different versions of PHP, node, etc.
+- Different Docker Compose (``fpm`` vs. ``apache`` images).
+- Each project was separate.
+- Difficult to add new features and fix bugs across all projects.
+- Inconsistencies across projects.
+- Out of the box solutions didn't seem like the best fit.
+
+.. raw:: pdf
+
+    TextAnnotation "Multiple projects with similar but different configurations."
+    TextAnnotation ""
+    TextAnnotation "Out of the box solutions tend to focus on one technology, could be hard to customise, and usually had more than I nedeed."
+    TextAnnotation ""
+    TextAnnotation "Start small and build up instead of removing additional things."
+    TextAnnotation ""
+    TextAnnotation "More opportunities to learn the underlying technologies."
+
+How Does it Work?
+=================
+
+.. image:: diagram.png
+    :width: 18cm
+
+.. raw:: pdf
+
+   TextAnnotation "Canonical templates and project-specific configuration goes in, templates come out."
+
+What Files Does it Generate?
+============================
+
+- Dockerfile, Docker Compose, Nix Flake, php.ini, NGINX default.conf.
+- ``run`` file.
+- PHPUnit, PHPCS, PHPStan.
+- GitHub Actions workflow.
+- Git hooks.

building-build-configs/sections/templates.rst

@@ -0,0 +1,117 @@
+.. raw:: pdf
+
+   PageBreak standardPage
+
+Dockerfile.twig
+===============
+
+.. code-block:: twig
+    :linenos:
+
+    FROM php:{{ php.version }} AS base
+
+    COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
+    RUN which composer && composer -V
+
+    ARG DOCKER_UID=1000
+    ENV DOCKER_UID="${DOCKER_UID}"
+
+    WORKDIR {{ project_root }}
+
+    RUN adduser --disabled-password --uid "${DOCKER_UID}" app \
+      && chown app:app -R {{ project_root }}
+
+Dockerfile.twig
+===============
+
+.. code-block:: twig
+   :linenos:
+
+    {% if dockerfile.stages.build.extensions.install %}
+    RUN docker-php-ext-install
+      {{ dockerfile.stages.build.extensions.install|join(' ') }}
+    {% endif %}
+
+    COPY --chown=app:app phpunit.xml* ./
+
+    {% if dockerfile.stages.build.extra_files %}
+    COPY --chown=app:app {{ dockerfile.stages.build.extra_files|join(" ") }} ./
+    {% endif %}
+
+    {% for directory in dockerfile.stages.build.extra_directories %}
+    COPY --chown=app:app {{ directory }} {{ directory }}
+    {% endfor %}
+
+docker-compose.yaml.twig
+========================
+
+.. code-block:: twig
+   :linenos:
+
+    services:
+    {% if "web" in dockerCompose.services %}
+      web:
+        <<: [*default-proxy, *default-app]
+        build:
+          context: .
+          target: web
+        depends_on:
+          - php
+        profiles: [web]
+    {% endif %}
+
+phpstan.neon.dist.twig
+======================
+
+.. code-block:: twig
+   :linenos:
+
+    parameters:
+      level: {{ php.phpstan.level }}
+      excludePaths:
+        - *Test.php
+        - *TestBase.php
+      paths:
+        {% for path in php.phpstan.paths -%}
+        - {{ path }}
+        {%- endfor %}
+
+    {% if php.phpstan.baseline %}
+    includes:
+      - phpstan-baseline.neon
+    {% endif %}
+
+phpunit.xml.dist.twig
+=====================
+
+.. code-block:: twig
+   :linenos:
+
+    <phpunit
+      beStrictAboutChangesToGlobalState="true"
+      beStrictAboutOutputDuringTests="false"
+      beStrictAboutTestsThatDoNotTestAnything="true"
+      bootstrap="{{ drupal.docroot }}/core/tests/bootstrap.php"
+      cacheResult="false"
+      colors="true"
+      failOnWarning="true"
+      printerClass="\Drupal\Tests\Listeners\HtmlOutputPrinter"
+    >
+
+phpunit.xml.dist.twig
+=====================
+
+.. code-block:: twig
+   :linenos:
+
+    <testsuites>
+      <testsuite name="functional">
+        <directory>./{{ drupal.docroot }}/modules/custom/**/tests/**/Functional</directory>
+      </testsuite>
+      <testsuite name="kernel">
+        <directory>./{{ drupal.docroot }}/modules/custom/**/tests/**/Kernel</directory>
+      </testsuite>
+      <testsuite name="unit">
+        <directory>./{{ drupal.docroot }}/modules/custom/**/tests/**/Unit</directory>
+      </testsuite>
+    </testsuites>

building-build-configs/slides.rst

@@ -0,0 +1,29 @@
+.. footer:: @opdavies
+
+Building "Build Configs"
+########################
+
+.. class:: titleslideinfo
+
+Oliver Davies (@opdavies)
+
+|
+
+.. class:: titleslideinfo
+
+https://opdavi.es/bco
+
+.. include:: ./sections/intro.rst
+.. include:: ./sections/example.rst
+.. include:: ./sections/customisation.rst
+.. include:: ./sections/templates.rst
+
+.. raw:: pdf
+
+   PageBreak titlePage
+
+.. class:: centredtitle
+
+Demo
+
+.. include:: ./sections/conclusion.rst

building-presenting-slide-decks-rst2pdf/README.rst

@@ -0,0 +1,4 @@
+Building and presenting slide decks with rst2pdf
+################################################
+
+https://www.oliverdavies.uk/talks/building-presenting-slide-decks-rst2pdf

building-presenting-slide-decks-rst2pdf/code/building.txt

@@ -0,0 +1,12 @@
+rst2pdf slides.rst
+
+
+rst2pdf slides.rst --break-level 1 --stylesheets main
+
+
+rst2pdf slides.rst \
+  --output slides.pdf \
+  --stylesheets main \
+  --break-level 1 \
+  --fit-background-mode scale \
+  --extension-module preprocess

building-presenting-slide-decks-rst2pdf/code/includes-code.txt

@@ -0,0 +1,4 @@
+.. code-block:: javascript
+    :include: code/additional-config-options.txt
+    :hl_lines: 2 3 4
+    :linenos:

building-presenting-slide-decks-rst2pdf/code/includes-sections.txt

@@ -0,0 +1 @@
+.. include:: sections/intro.rst

building-presenting-slide-decks-rst2pdf/code/page-templates-rst.txt

@@ -0,0 +1,3 @@
+.. raw:: pdf
+
+    PageBreak standardPage

building-presenting-slide-decks-rst2pdf/code/page-templates-style.txt

@@ -0,0 +1,6 @@
+pageTemplates:
+    standardPage:
+        frames: []
+            [3%, 3%, 92%, 92%]
+        showFooter: true
+        showHeader: false

building-presenting-slide-decks-rst2pdf/code/styling.txt

@@ -0,0 +1,29 @@
+linkColor: #24608a
+
+styles:
+    normal:
+        fontSize: 24
+        leading: 32
+        textColor: #383745
+
+    bodytext:
+        alignment: TA_LEFT
+
+    heading:
+        fontSize: 20
+        spaceAfter: 16
+        textColor: #24608a
+
+    title:
+        fontSize: 300%
+        parent: heading
+        textColor: white
+
+    bullet-list:
+        commands: []
+             [LEFTPADDING, [0, 0], [1, -1], 10]
+             [RIGHTPADDING, [0, 0], [1, -1], 0]
+             [VALIGN, [0, 0], [-1, -1], TOP]
+        colWidths: ["20", null]
+        textColor: #aaaaaa
+

building-presenting-slide-decks-rst2pdf/code/useful-rst-1.txt

@@ -0,0 +1,14 @@
+Building and presenting slide decks with rst2pdf
+################################################
+
+.. class:: titleslideinfo
+
+Oliver Davies (@opdavies)
+
+
+What is rst2pdf?
+================
+
+* "Use a text editor. Make a PDF."
+* reStructuredText to PDF
+* Each slide is a page

building-presenting-slide-decks-rst2pdf/code/useful-rst-2.txt

@@ -0,0 +1,14 @@
+.. image:: images/editing.png
+    :width: 20cm
+
+
+.. code-block:: php
+    :startinline: true
+    :linenos:
+
+    echo 'Hello world!';
+
+
+.. raw:: pdf
+
+    TextAnnotation "This is a speaker note."

building-presenting-slide-decks-rst2pdf/code/watching.txt

@@ -0,0 +1,8 @@
+nodemon --ext rst,style,txt --exec "
+  rst2pdf slides.rst \
+    --output slides.pdf \
+    --stylesheets main \
+    --break-level 1 \
+    --fit-background-mode scale \
+    --extension-module preprocess
+"

building-presenting-slide-decks-rst2pdf/slides.rst

@@ -0,0 +1,169 @@
+.. footer:: @opdavies
+
+Building and presenting slide decks with rst2pdf
+################################################
+
+|
+
+.. class:: titleslideinfo
+
+Oliver Davies (@opdavies)
+
+.. raw:: pdf
+
+    TextAnnotation "Gave my first talk in 2012."
+    TextAnnotation "A talk about a tool (rst2pdf) that I've been using for the last couple of talks."
+
+.. page:: standardPage
+
+What have I used before?
+========================
+
+* **UI based:** Keynote, Google Slides, slides.com
+* **HTML/JavaScript:** reveal.js
+* **Markdown:** Deckset, Marp, reveal-md
+
+What is rst2pdf?
+================
+
+* "Use a text editor. Make a PDF."
+* reStructuredText to PDF
+* Each slide is a page
+* Page templates for layouts
+* Not just for slide decks
+* Table of contents, page numbers, headers, footers
+
+.. raw:: pdf
+
+    TextAnnotation "Use the tools you're familiar with."
+    TextAnnotation "Similar to Markdown."
+    TextAnnotation "Primarily used for technical documentation within the Python community."
+    TextAnnotation "Now maintained by PHPers Rob Allen and Lorna Jane Mitchell."
+    TextAnnotation "Breaks at titles automatically, or you can add manual page breaks."
+
+Advantages
+==========
+
+* Easy to start a new presentation, or update an existing one
+* Version controllable
+* Portable
+* Content is searchable
+* Easy to re-use content and/or styling
+* Slides uploaded to SpeakerDeck straight away
+
+.. page:: imagePage
+
+.. image:: images/editing.png
+    :width: 23cm
+
+.. page:: standardPage
+
+Useful reStructuredText
+=======================
+
+.. code-block:: rst
+    :include: code/useful-rst-1.txt
+    :linenos:
+
+Useful reStructuredText
+=======================
+
+.. code-block:: rst
+    :include: code/useful-rst-2.txt
+    :linenos:
+
+Page Templates
+==============
+
+main.style:
+
+.. code-block:: yaml 
+    :include: code/page-templates-style.txt
+
+slides.rst:
+
+.. code-block:: rst
+    :include: code/page-templates-rst.txt
+
+Keeping things organised
+========================
+
+Split slides into different sections:
+
+.. code-block:: rst
+   :include: code/includes-sections.txt
+
+|
+
+Including code snippets from separate files:
+
+.. code-block:: rst
+    :include: code/includes-code.txt
+
+.. raw:: pdf
+
+    TextAnnotation "Includes!"
+
+Styling
+=======
+
+.. code-block:: yaml
+    :include: code/styling.txt
+    :linenos:
+
+Building
+========
+
+.. code-block::
+    :include: code/building.txt
+
+Watching
+========
+
+Re-compiling when something changes.
+
+|
+
+.. code-block:: bash
+    :include: code/watching.txt
+
+Presenting
+==========
+
+``pdfpc`` - PDF presenter console
+
+|
+
+.. code-block::
+
+    pdfpc slides.pdf
+
+.. page:: imagePage
+
+.. image:: images/pdfpc-1.png
+    :width: 23cm
+
+.. raw:: pdf
+
+    PageBreak
+
+.. image:: images/pdfpc-2.png
+    :width: 23cm
+
+.. page:: standardPage
+
+Thanks!
+=======
+
+References:
+
+* https://rst2pdf.org
+* https://github.com/rst2pdf/rst2pdf
+* https://github.com/opdavies/talks
+* https://oliverdavies.link/lorna-rst2pdf-talk
+
+|
+
+Me:
+
+* https://www.oliverdavies.uk

building-static-websites-sculpin/demo/.envrc

@@ -0,0 +1 @@
+use flake

building-static-websites-sculpin/demo/.gitignore

@@ -0,0 +1,10 @@
+/output_*/
+
+/.phpunit.cache
+/.phpunit.result.cache
+
+# Nix
+/.direnv/
+
+# Composer
+/vendor/

building-static-websites-sculpin/demo/build

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+export PATH="$PATH:./vendor/bin"
+
+sculpin generate "$@"

building-static-websites-sculpin/demo/build-configs.yaml

@@ -0,0 +1,3 @@
+---
+name: demo
+template: php-sculpin

building-static-websites-sculpin/demo/clean

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+rm -rfv output_* vendor

building-static-websites-sculpin/demo/flake.lock

@@ -0,0 +1,27 @@
+{
+  "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1740828860,
+        "narHash": "sha256-cjbHI+zUzK5CPsQZqMhE3npTyYFt9tJ3+ohcfaOF/WM=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "303bd8071377433a2d8f76e684ec773d70c5b642",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

building-static-websites-sculpin/demo/flake.nix

@@ -0,0 +1,26 @@
+{
+  inputs.nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+
+  outputs = inputs:
+    let
+      system = "x86_64-linux";
+      pkgs = import inputs.nixpkgs { inherit system; };
+    in
+    {
+      devShells.${system}.default =
+        with pkgs;
+        mkShell {
+          buildInputs = [
+            nodePackages.browser-sync
+
+            (php83.buildEnv {
+              extraConfig = ''
+                error_reporting = E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED
+              '';
+            })
+
+            php83Packages.composer
+          ];
+        };
+    };
+}

building-static-websites-sculpin/demo/watch

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+export PATH="$PATH:./vendor/bin"
+
+sculpin generate --server --watch "$@"

building-static-websites-sculpin/slides/README.rst

@@ -0,0 +1,4 @@
+Building static websites with Sculpin
+#####################################
+
+https://www.oliverdavies.uk/talks/building-static-websites-sculpin

building-static-websites-sculpin/slides/code/configuration.txt

@@ -0,0 +1,5 @@
+---
+name: oliverdavies.uk
+menu_links:
+  - { title: Home, href: / }
+  - { title: About, href: /about }

building-static-websites-sculpin/slides/code/content-types.txt

@@ -0,0 +1,10 @@
+---
+title: My Daily Email Archive
+layout: default
+use:
+  - daily_email
+---
+
+{% for email in data.daily_emails %}
+  <p>{{ email.title }}</p>
+{% endfor %}

building-static-websites-sculpin/slides/code/front-matter-on-pages.txt

@@ -0,0 +1,12 @@
+---
+...
+testimonials:
+  - { name: ..., role: ..., text: ..., url: ... }
+  - { name: ..., role: ..., text: ..., url: ... }
+  - { name: ..., role: ..., text: ..., url: ... }
+---
+
+{% for testimonial in page.testimonials %}
+  <h2>{{ testimonial.name }} - {{ testimonial.role }}</h2>
+  <p>{{ testimonial.text }}</p>
+{% endfor %}

building-static-websites-sculpin/slides/code/front-matter1.txt

@@ -0,0 +1,5 @@
+---
+layout: post
+title: New blog post
+draft: yes
+---

building-static-websites-sculpin/slides/code/index.html.txt

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>Hello!</title>
+    </head>
+    <body>
+        <p>Hello, World!</p>
+    </body>
+</html>

building-static-websites-sculpin/slides/code/index.md.txt

@@ -0,0 +1,6 @@
+---
+layout: default
+title: Hello!
+---
+
+Hello, World!

building-static-websites-sculpin/slides/code/layout-base.txt

@@ -0,0 +1,11 @@
+{# source/_layouts/base.html.twig #}
+
+<!DOCTYPE html>
+<html lang="{{ site.locale|default('en') }}">
+  <head>
+    <title>{{ site.name|default('Sculpin Skeleton') }}</title>
+  </head>
+  <body>
+    {% block body %}{% endblock %}
+  </body>
+</html>

building-static-websites-sculpin/slides/code/layout-page.txt

@@ -0,0 +1,7 @@
+{# source/_layouts/page.html.twig #}
+
+{% extends 'base' %}
+
+{% block body %}
+    {% block content %}{% endblock %}
+{% endblock %}

building-static-websites-sculpin/slides/code/project-structure.txt

@@ -0,0 +1,13 @@
+app/
+  config/
+    sculpin_kernel.yml
+    sculpin_site.yml
+composer.json
+composer.lock
+output_dev/
+output_prod/
+source/
+  _includes/
+  _templates/
+  index.md
+vendor/

building-static-websites-sculpin/slides/code/twig-1.txt

@@ -0,0 +1,8 @@
+{{ 'today' }}
+
+{{ 'today'|date }}
+
+{{ 'today'|date('Y') }}
+
+{{ 'today'|date('Y') - 2007 }} # 18 (years of experience)
+

building-static-websites-sculpin/slides/code/twig-2.txt

@@ -0,0 +1,24 @@
+---
+title: Building Static Websites with Sculpin
+events:
+  - name: PHP Berkshire
+    date: 2024-08-28
+    location: Reading, UK
+    url: https://www.meetup.com/php-berkshire/events/301850284
+  - name: BrumPHP
+    date: 2024-05-23
+    location: Birmingham, UK
+    url: https://www.eventbrite.com/e/brumphp-23rd-may-2024-tickets-803037766577
+---
+// end yaml
+
+// start twig
+{% set talkCount = 0 %}
+
+{% for talk in data.talks %}
+  {% for event in talk.events if 'today'|date('U') >= event.date|date('U') %}
+    {% set talkCount = talkCount + 1 %}
+  {% endfor %}
+{% endfor %}
+
+<p>I have given {{ talkCount }} talks.</p>

building-static-websites-sculpin/slides/code/twig-3.txt

@@ -0,0 +1,15 @@
+{% set talks = site.talks|filter(talk => talk.speaker == page.name) %}
+
+{% if talks is not empty %}
+  <section>
+    <h2>Talks by {{ page.name }}</h2>
+
+    <div>
+      <ul>
+        {% for talk in talks %}
+          <li><a href="#0">{{ talk.title }}</a></li>
+        {% endfor %}
+      </ul>
+    </div>
+  </section>
+{% endif %}

building-static-websites-sculpin/slides/demo.txt

@@ -0,0 +1,8 @@
+- Adding a new page (`/talks`)
+- Adding a new menu link
+- Adding a new content type (talks)
+- Add a new talk
+- Show how to use page-level variables, adding events to a talk
+- Adding the talks page to the menu
+- Active menu link styling?
+- Generating a production version of the site