Skip to content

Commit

Permalink
fix: privateRemarks should span multiple paragraphs
Browse files Browse the repository at this point in the history
The current implementation expects that privateRemarks is followed by one and only one paragraph.
This commit fixes this issue allowing that multiple paragraphs can be used as privateRemarks.
  • Loading branch information
alanrodas committed Sep 5, 2024
1 parent 42a28e0 commit 632e01b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## <small>0.3.1 (2024-09-05)</small>

- fix: privateRemarks should span multiple paragraphs ([032c993](https://github.com/gobstones/typedoc-theme-gobstones/commit/032c993))
- build: updated gobstones-scripts to 0.9.2 ([42a28e0](https://github.com/gobstones/typedoc-theme-gobstones/commit/42a28e0))

## 0.3.0 (2024-09-04)

## <small>0.2.1 (2024-08-09)</small>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@gobstones/typedoc-theme-gobstones",
"description": "A simple theme for the Gobstones generated documentation.",
"version": "0.3.0",
"version": "0.3.1",
"keywords": ["Gobstones", "typedoc-theme", "typedoc-theme-gobstones"],
"repository": {
"type": "git",
Expand Down
10 changes: 7 additions & 3 deletions src/static/assets/js/typedoc-theme-gobstones.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ document.addEventListener('DOMContentLoaded', () => {
const privateRemarks = document.getElementById('Private Remarks');
if (!privateRemarks) return;
const privateRemarksTitle = privateRemarks.parentElement;
const privateRemarksText = privateRemarksTitle.nextElementSibling;
privateRemarksTitle.classList.add('tsd-is-internal');
privateRemarksTitle.classList.add('tsd-private-remarks');
privateRemarksText.classList.add('tsd-is-internal');
privateRemarksText.classList.add('tsd-private-remarks');

let privateRemarksText = privateRemarksTitle.nextElementSibling;
while (privateRemarksText) {
privateRemarksText.classList.add('tsd-is-internal');
privateRemarksText.classList.add('tsd-private-remarks');
privateRemarksText = privateRemarksText.nextElementSibling;
}
});

0 comments on commit 632e01b

Please sign in to comment.