Remove Jekyll and Hugo as SSG "frequently-used frameworks" and replace with 11ty #751
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
mgwalker
force-pushed
the
mgwalker-patch-1
branch
from
bf2d6b0
to
5222d56
Compare
mgwalker
force-pushed
the
mgwalker-patch-1
branch
from
5222d56
to
b46ac4a
Compare
mgwalker
commented
Nov 14, 2024
Comment on lines
-40
to
+61
| | Purpose | Tool | | ||
| | ---- | ---- | | ||
| | CSS framework | [_More info_]({{ "/engineering/languages-runtimes/css/#frameworks" | url }}) | | ||
| | Infrastructure/configuration as code | [Terraform](https://www.terraform.io/) | | ||
| | Static site generator | [Jekyll](https://jekyllrb.com/) (with the [uswds-jekyll](https://github.com/18F/uswds-jekyll) theme) or Hugo | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Purpose</th> | ||
| <th>Tool</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>CSS framework</td> | ||
| <td><a href="{{ "/engineering/languages-runtimes/css/#frameworks" | url }}"><em>More info</em></a></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Infrastructure/configuration as code</td> | ||
| <td><a href="https://www.terraform.io/">Terraform</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Static site generator</td> | ||
| <td>{% include "engineering/tag-default.html" %} <a href="https://www.11ty.dev/">11ty/Eleventy</a></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> |
There was a problem hiding this comment.
The default tag snippet has a trailing newline, which is pretty standard (our prettier config wants it, for example). However, if you include the tag within markdown, it gets inserted into the markdown before the markdown is parsed, which means it can break markdown syntax. For example, a table row like this:
| Static site generator | {% include "tag" %} 11ty |
becomes
| Static site generator | tag
11ty |
When then renders as two table rows instead of one. The fix options are either remove the trailing newline from the tag snippets, which seems very fragile because anyone in the future who tweaks one and runs prettier would suddenly break this table, or replace the markdown table with an HTML one. I chose the latter. 😛
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes proposed in this pull request:
Just what it says on the tin.
security considerations
None