Skip to content

GitHub action to strip Markdown file extensions from links (useful for making links work with GitHub wiki)

License

Notifications You must be signed in to change notification settings

impresscms-dev/strip-markdown-extensions-from-links-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

License GitHub release

Strip MarkDown extensions from links action

GitHub action to strip Markdown file extensions from links (useful for making links work with GitHub wiki).

Usage

To use this action in your project, create workflow in your project similar to this code (Note: some parts and arguments needs to be altered):

name: Generate documentation

on:
  push:

jobs:
  get_php_classes_list:
    runs-on: ubuntu-latest
    steps:
      - name: Checkouting project code...
        uses: actions/checkout@v2
        
      - name: Install PHP
        uses: shivammathur/setup-php@master
        with:
          php-version: 8.1
          extensions: curl, gd, pdo_mysql, json, mbstring, pcre, session
          ini-values: post_max_size=256M
          coverage: none
          tools: composer:v2
          
      - name: Install Composer dependencies (with dev)
        run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader       
          
      - name: Generating documentation...
        uses: impresscms-dev/[email protected]
        with:
          class_root_namespace: ImpressCMS\
          included_classes: ImpressCMS\**
          output_path: ./docs/
          
      - name: Stripping file extensions...
        uses: impresscms-dev/[email protected]
        with:
          path: ./docs/
          
      - uses: actions/upload-artifact@v3
        with:
          name: my-artifact
          path: ./docs/

Arguments

This action supports such arguments (used in with keyword):

Argument Required Default value Description
path Yes Folder where are markdown files to process links

How to contribute?

If you want to add some functionality or fix bugs, you can fork, change and create pull request. If you not sure how this works, try interactive GitHub tutorial.

If you found any bug or have some questions, use issues tab and write there your questions.

About

GitHub action to strip Markdown file extensions from links (useful for making links work with GitHub wiki)

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •