Step 1: Start modifying settings file
powershell2 years ago
docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest migrate DocumentationStep 2: Delete or modify files
rst2 years ago
.. You can put central messages to display on all pages hereStep 3: Modify guides.xml
xml2 years ago
interlink-shortcode="my-vendor/my-ext-key"Step 4: Create files locally
powershell2 years ago
# Create a directory
mkdir -p Documentation-GENERATED-temp
# Execute the Docker container that is provided remotely.
# Renders all files in the `Documentation` and store in `Documentation-GENERATED-temp`.
# On macOS you need to specify the parameter "--user=$(id -u):$(id -g)"
docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=DocumentationStep 7: Include tests (Github actions)
yaml2 years ago
name: test documentation
on: [ push, pull_request ]
jobs:
tests:
name: documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Test if the documentation will render without warnings
run: |
mkdir -p Documentation-GENERATED-temp \
&& docker run --rm --pull always -v $(pwd):/project \
ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log