Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Enhance docs #162

Merged
merged 1 commit into from
Jan 15, 2025
+855 −26
Merged

docs: Enhance docs #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/Plugins/ktor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ See the following comparison:
}
```
=== "SDL"
```
```graphql
type Query {
getSampleData(quantity: Int! = 10): [SampleData!]!
}
Expand Down
2 changes: 1 addition & 1 deletion docs/content/Reference/Type System/objects-and-interfaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ configure {
}
```

*example*
*Example*

```kotlin
data class Person(val id: Int, val name: String)
Expand Down
837 changes: 837 additions & 0 deletions docs/content/assets/hljs/highlight.min.js
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 0 additions & 6 deletions docs/content/assets/hljs/highlight.pack.js
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/assets/hljs/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Highlight */
(function (hljs) {
hljs.initHighlightingOnLoad();
hljs.highlightAll();
})(hljs);
32 changes: 15 additions & 17 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ site_description: KGraphQL Documentation
site_url: https://stuebingerb.github.io/KGraphQL/
dev_addr: 0.0.0.0:8000

repo_name: 'GitHub'
repo_name: 'stuebingerb/KGraphQL'
repo_url: 'https://github.com/stuebingerb/KGraphQL'

docs_dir: 'content'
Expand All @@ -20,9 +20,17 @@ theme:
feature:
tabs: false
palette:
scheme: preference
primary: 'pink'
accent: 'pink'
- media: "(prefers-color-scheme)"
primary: 'black'
accent: 'blue'
- media: "(prefers-color-scheme: light)"
scheme: default
primary: 'black'
accent: 'blue'
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: 'black'
accent: 'blue'
i18n:
prev: 'Previous'
next: 'Next'
Expand All @@ -31,7 +39,7 @@ extra_css:
- assets/hljs/styles/atom-one-light.css # HightlightJS's CSS theme

extra_javascript:
- assets/hljs/highlight.pack.js # Download from https://highlightjs.org/download/
- assets/hljs/highlight.min.js # Download from https://highlightjs.org/download/
- assets/hljs/init.js

plugins:
Expand All @@ -40,23 +48,13 @@ plugins:
glob:
- "**/include-*.md"

# https://squidfunk.github.io/mkdocs-material/extensions/admonition/
# https://facelessuser.github.io/pymdown-extensions/
markdown_extensions:
- attr_list
- admonition
- footnotes
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist
- pymdownx.highlight:
use_pygments: false
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets:
check_paths: true
- toc:
permalink: true

extra:
social:
Expand Down
Loading