This repository has been archived by the owner on Jan 9, 2025. It is now read-only.
Converting the main description Yaml Block Literal to support proper Markdown #111
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
closing as included in the new specs which is inlined in apify-docs |
netmilk
added a commit
to apify/apify-docs
that referenced
this pull request
Nov 29, 2024
This was caused by the manual edits after the migration, improper use of YAML folded block scalar, and fixed the same way as apify/openapi#111 **After:**  **Before** 
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've converted the
.info.descriptionblock to address the broken formatting of GFM fenced code block. The change makes the YAML string under the key work as a normal Markdown.It's a simple trick: using of
description: |instead ofdescription: >-. But then the entire multi-line string needs to be rewritten/converted to omit the unnecessary newlines. I used this dirty script to do the job.More on the YAML mult-line behavior here: https://yaml-multiline.info/
After
Before
