Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make module source urls clickable in Markdown output #571

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Make module source urls clickable in Markdown output #571

wants to merge 3 commits into from

Commits on Oct 1, 2021

  1. Make module source urls clickable in Markdown output 

    The main reason this was not already implemented, as outlined in terraform-docs#504 and
linked discussions, was that modules sourced from git repositories, with
urls like `[email protected]:...`, was rendered by Markdown as URL to an
email address, if the url was just shown as `[.source](.source)`.

The approach here is to detect if the module source starts with "git@",
and, if so, replace that prefix with "https://", as well as replacing the
first ":" with a "/".

Signed-off-by: Tomas Aschan <[email protected]>
    @tomasaschan
    tomasaschan committed Oct 1, 2021
    Configuration menu
    Copy the full SHA
    ced2aed View commit details
    Browse the repository at this point in the history

  2. Decrease indentation to satisfy linter 

    Signed-off-by: Tomas Aschan <[email protected]>
    @tomasaschan
    tomasaschan committed Oct 1, 2021
    Configuration menu
    Copy the full SHA
    3dbb1a9 View commit details
    Browse the repository at this point in the history

  3. Update docs 

    Signed-off-by: Tomas Aschan <[email protected]>
    @tomasaschan
    tomasaschan committed Oct 1, 2021
    Configuration menu
    Copy the full SHA
    cc9569e View commit details
    Browse the repository at this point in the history