Skip to content

Typing - Readme SVG Text

Actions
Text to svg in readme
2.0.6
Latest
Star (4)

Tags

 (1)

Typing - Readme SVG Text

Update your readme with SVG typing texts.

Instructions

  • Add this comment in your README.md file

    <!-- START:readme-typing --> 
    <!-- END:readme-typing -->
    

    you can find an example here

  • Create a workflow file

    .github/workflows/readme-typing.yml

    name: Readme - svg text
    on:
      workflow_dispatch:
    jobs:
      update-readme:
        runs-on: ubuntu-latest
        steps:
        - name: Checkout code
          uses: actions/checkout@v3
        - name: Run the action
          uses: tonalmathew/readme-typing@main
          env:
            GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
          with:
            INPUT_TEXT: |
              Hello, from svg typing.
              Add more text line by line.
  • The above job won't run automatically, you need to run the job manually from the actions tab.

Override defaults

Use the following input params to customize it for your use case:-

Input Param Default Value Description
COMMITTER_NAME github-actions[bot] Name of the committer
COMMITTER_EMAIL 41898282+github-actions[bot]@users.noreply.github.com Email of the committer
COLOR #36BCF7 Color of the text
TEXT_ALIGN start (available values: start, center) Align the svg text position

An alternative method for DenverCoder1/readme-typing-svg

Typing - Readme SVG Text is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Text to svg in readme
2.0.6
Latest

Tags

 (1)

Typing - Readme SVG Text is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.