You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When we add shortcodes to a markdown code block (see example below), we "break" the signature for a valid markdown code block. Vale no longer is able to determine that it is a code block and be ignore and instead parses it as just a string. This causes it to error because of the properties in the code block (e.g. passthru, post_deploy, etc). We can't add a new ignore pattern as a TokenIgnore because we need to ignore the entire block. Instead, we'll need to add a new block-level ignore pattern that can match a code block with a shortcode in the first line.
Example of a code block that breaks the markdown code block signature (ignoring the backslash for the closing marker as I couldn't figure out how to get markdown to escape it properly):
```yaml {configFile="app"}
hooks:
deploy: |
cd /app/public
if [ "$PLATFORM_ENVIRONMENT_TYPE" = production ]; then
# Do whatever you want on the production site.
else
drush -y sql:sanitize
fi
drush -y updatedb
\```
Additional context
No response
The text was updated successfully, but these errors were encountered:
Where on docs.platform.sh should be changed?
https://github.com/platformsh/platformsh-docs/blob/main/.vale.ini#L12
What exactly should be updated?
When we add shortcodes to a markdown code block (see example below), we "break" the signature for a valid markdown code block. Vale no longer is able to determine that it is a code block and be ignore and instead parses it as just a string. This causes it to error because of the properties in the code block (e.g.
passthru
,post_deploy
, etc). We can't add a new ignore pattern as a TokenIgnore because we need to ignore the entire block. Instead, we'll need to add a new block-level ignore pattern that can match a code block with a shortcode in the first line.Example of a code block that breaks the markdown code block signature (ignoring the backslash for the closing marker as I couldn't figure out how to get markdown to escape it properly):
Additional context
No response
The text was updated successfully, but these errors were encountered: