Skip to content

[BUG] Generation with version v0.19.0 removes links and bulletpoints  #355

@lechnerc77

Description

@lechnerc77

Terraform CLI and terraform-plugin-docs Versions

Terraform version: 1.7.3
terraform-plugin-docs: 0.19.0

Provider Code

The resource template:
---
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: ""
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
---

# {{.Name}} ({{.Type}})

{{ .Description | trimspace }}

{{ if .HasExample -}}
## Example Usage

{{tffile .ExampleFile}}
{{- end }}

{{ .SchemaMarkdown | trimspace }}

{{ if .HasImport -}}
## Import

Import is supported using the following syntax:

{{tffile .ImportFile}}
{{- end }}

Expected Behavior

With the update from version 0.18.0 to 0.19.0 there are no changes in the generated markdown

Actual Behavior

The markdown gets reformated (bullet points are removed without proper spacing) as well as links are removed

Steps to Reproduce

  1. tfplugindocs generate --rendered-provider-name "SAP BTP"

How much impact is this issue causing?

Medium

Logs

No response

Additional Information

Here some screenshots that highlight the mismatch between the versions:

  • The template that is used
    Screenshot 2024-04-16 081035

  • The schema of the resource with the desscriptions
    Screenshot 2024-04-16 081138

  • The Git diff between version 0.18.0 and 0.19.0
    Screenshot 2024-04-16 080712

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions