README.md

phplang.org

This repository includes php/php-langspec as a submodule.

Cloning and Getting the Submodule

git clone https://github.com/phpcommunity/phplang.org.git
cd phplang.org/
git submodule update --init --recursive

Generating Locally

This project uses mdBook to generate documentation from Markdown files. To generate the documentation locally, install mdBook. Then, run the following from the project root:

php tools/toc.php
php tools/colophon.php
mdbook build --open

This will open the files in your default web browser.

Update the Submodule

git submodule update --recursive --remote

Deploying to GitHub Pages

GitHub Actions handles the deployment to GitHub Pages automatically. See the build.yml workflow, for more information.