Git Product home page Git Product logo

gh-render-action's Introduction

TYPO3 Documentation Rendering

Render documentation with the official TYPO3 Documentation rendering container.

Usage

You will have to have a Documentation folder in your working directory. Then:

      - name: Render documentation
        uses: TYPO3-Documentation/gh-render-action@<version>
        id: rendering
        # Optional configuration:
        # with:
          # if you are not rendering the current repository but a different one
          # enter the repository_url here:
          # repository_url: https://example.org/your-repository.git
          
          # if you want to render a branch different from the current branch enter the name: 
          # source_branch: 'main'
          
          # this is the directory name in the final folder structure used to contain this 
          # version of the repository. If not given, the source branch name is used.
          # target_branch_directory: 'latest'

      - name: Publish archive with result
        uses: actions/upload-artifact@v1
        with:
          name: Rendered
          path: ${{ steps.rendering.outputs.renderedPath }}

As you can see the actions provides the output path as output to use in further steps.

gh-render-action's People

Contributors

marble avatar jaapio avatar susannemoog avatar linawolf avatar alexander-nitsche avatar andreaskienast avatar brotkrueml avatar mbrodala avatar oskarstark avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.