Skip to content

Commit

Permalink
🐛 [-bug] Fix markdown rendering issue
Browse files Browse the repository at this point in the history
With the previous change, comments delimiting sections dynamically populated are preserved to support better git diffs. However, this caused a regression in how markdown tables are rendered, as the HTML comments were embedded within the table, breaking GitHub's ability to render the markdown table. The fix is to move the delimiting comment outside of the table definition.
  • Loading branch information
davidbrownell committed Sep 17, 2024
1 parent 0fa5f3d commit 2260e53
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 43 deletions.
2 changes: 0 additions & 2 deletions template/__documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ TODO: Complete this section
## Additional Information
Additional information can be found at these locations.

| Title | Document | Description |
| --- | --- | --- |
<!-- [BEGIN] Additional Information -->
<!-- [END] Additional Information -->

Expand Down
4 changes: 4 additions & 0 deletions template/__documentation/__postprocess.py
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,8 @@ def UpdateReadmeFile():
replacement_info["Development"] = "Please visit CONTRIBUTING.md and DEVELOPMENT.md for information on contributing to this project."
replacement_info["Additional Information"] = textwrap.dedent(
"""\
| Title | Document | Description |
| --- | --- | --- |
| Code of Conduct | CODE_OF_CONDUCT.md | Information about the the norms, rules, and responsibilities we adhere to when participating in this open source community. |
| Contributing | CONTRIBUTING.md | Information about contributing code changes to this project. |
| Development | DEVELOPMENT.md | Information about development activities involved in making changes to this project. |
Expand All @@ -219,6 +221,8 @@ def UpdateReadmeFile():
replacement_info["Development"] = "Please visit [Contributing]({{ github_url }}/blob/main/CONTRIBUTING.md) and [Development]({{ github_url }}/blob/main/DEVELOPMENT.md) for information on contributing to this project."
replacement_info["Additional Information"] = textwrap.dedent(
"""\
| Title | Document | Description |
| --- | --- | --- |
| Code of Conduct | [CODE_OF_CONDUCT.md]({{ github_url }}/blob/main/CODE_OF_CONDUCT.md) | Information about the the norms, rules, and responsibilities we adhere to when participating in this open source community. |
| Contributing | [CONTRIBUTING.md]({{ github_url }}/blob/main/CONTRIBUTING.md) | Information about contributing code changes to this project. |
| Development | [DEVELOPMENT.md]({{ github_url }}/blob/main/DEVELOPMENT.md) | Information about development activities involved in making changes to this project. |
Expand Down
Loading

0 comments on commit 2260e53

Please sign in to comment.