Skip to content

Synchronize a readme.io documentation from the readme of a Github repository. From api.video (https://api.video)

License

Notifications You must be signed in to change notification settings

apivideo/api.video-readmeio-document-sync-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

badge   badge   badge

readmeio-document-sync-action

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Table of contents

Project description

This action let you synchronize a readme.io documentation using a markdown file from your repository.

Documentation

Inputs

document-slug

Required Slug of the readme.io document to synchronize.

markdown-file-path

Required The path of the markdown file to use for synchronization (eg. README.md�).

readme-io-api-key

Required Your API key to request readme.io.

make-relative-links-absolute

If true, all relative markdown links in the markdown will be made absolute (default: false).

Outputs

response

The status code of the response from readme.io.

Example usage

uses: apivideo/api.video-readmeio-document-sync-action
with:
  document-slug: 'my-software-documentation'
  markdown-file-path: README.md
  make-relative-links-absolute: true
  readme-io-api-key: ${{ secrets.README_IO_API_KEY }}

About

Synchronize a readme.io documentation from the readme of a Github repository. From api.video (https://api.video)

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •