Skip to content

Commit

Permalink
docs: exclude summary page from search (#1035)
Browse files Browse the repository at this point in the history 
### Summary of Changes

The summary page is only needed for navigation. It should never be
accessed directly. This PR excludes the page from the search.
  • Loading branch information
@lars-reimann
lars-reimann authored Apr 12, 2024
1 parent b930cd5 commit fc6e131
Show file tree
Hide file tree
Showing 31 changed files with 153 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/stdlib/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- safeds
- data
- image
Expand Down
4 changes: 3 additions & 1 deletion packages/safe-ds-lang/src/language/generation/safe-ds-markdown-generator.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,9 @@ export class SafeDsMarkdownGenerator {
options.destination,
details.map((document) => URI.parse(document.uri)),
);
const content = this.describeSummary('', summary);

const frontMatter = `---\nsearch:\n exclude: true\n---\n\n`;
const content = frontMatter + this.describeSummary('', summary);

return TextDocument.create(uri, 'md', 0, content);
}
Expand Down
5 changes: 5 additions & 0 deletions ...tests/resources/generation/markdown/annotations/deprecated/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...tests/resources/generation/markdown/annotations/documented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...sts/resources/generation/markdown/annotations/experimental/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...sts/resources/generation/markdown/annotations/undocumented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...ang/tests/resources/generation/markdown/classes/deprecated/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...ang/tests/resources/generation/markdown/classes/documented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...g/tests/resources/generation/markdown/classes/experimental/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...g/tests/resources/generation/markdown/classes/undocumented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...afe-ds-lang/tests/resources/generation/markdown/deprecated/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...-lang/tests/resources/generation/markdown/enums/deprecated/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...-lang/tests/resources/generation/markdown/enums/documented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...ang/tests/resources/generation/markdown/enums/experimental/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...ang/tests/resources/generation/markdown/enums/undocumented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...g/tests/resources/generation/markdown/functions/deprecated/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...g/tests/resources/generation/markdown/functions/documented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...tests/resources/generation/markdown/functions/experimental/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...tests/resources/generation/markdown/functions/undocumented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions .../safe-ds-lang/tests/resources/generation/markdown/link tag/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...safe-ds-lang/tests/resources/generation/markdown/multiline/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...safe-ds-lang/tests/resources/generation/markdown/pipelines/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...ang/tests/resources/generation/markdown/schemas/deprecated/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...ang/tests/resources/generation/markdown/schemas/documented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...g/tests/resources/generation/markdown/schemas/experimental/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...g/tests/resources/generation/markdown/schemas/undocumented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...ng/tests/resources/generation/markdown/segments/deprecated/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...ng/tests/resources/generation/markdown/segments/documented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions .../tests/resources/generation/markdown/segments/experimental/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions .../tests/resources/generation/markdown/segments/undocumented/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down
5 changes: 5 additions & 0 deletions ...s/safe-ds-lang/tests/resources/generation/markdown/summary/generated/SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

- tests
- generation
- markdown
Expand Down

0 comments on commit fc6e131

Please sign in to comment.