Migration

PHP-based TYPO3 documentation rendering
 avataruser_4375421
Public2 years ago8 Snippets
Search
Language
Sort by
📅 Created Date
Order
Generate the guides.xml
docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest migrate Documentation
Empty your file Includes.rst.txt and add this comment.
.. You can put central messages to display on all pages here
Insert this attribute in your extension tag with appropriate name from your composer.json.
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=Documentation
Code for ext_key/.github/workflows/test-documentation.yml
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
  • Total 8 snippets
  • 1
  • 2