Skip to content
play

GitHub Action

Quix Library readme importer

v1.7 Pre-release

Quix Library readme importer

play

Quix Library readme importer

Import readmes from the Quix Library into mkdocs

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Quix Library readme importer

              
  uses: SteveRosam/[email protected]
Learn more about this action in SteveRosam/QuixReadmeAction

Choose a version

Python Container Action Template

Quix Library readme importer. Import readmes from the Quix Library into MKdocs.

Usage

Use to add readme.md files from Quix Library to MKDocs

Example workflow

    - name: Quix Library readme importer
      uses: SteveRosam/QuixReadmeAction@Master
      with:
        LIBRARY_REPO_PATH: "repo"
        DOCS_PATH: "docs"
        REPLACEMENT_PLACEHOLDER: "    - 'ConnectorsGetInsertedHere': ''"
        README_DEST: "docs/docs/library_readmes/connectors"

Inputs

Outputs

Examples

Using the optional input

Using outputs