Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Enhance docs
Browse files Browse the repository at this point in the history
- Update highlightjs
- Remove unused extensions
- Support dark mode
- Adjust colors
stuebingerb committed Jan 14, 2025
1 parent a7e77e6 commit 46b9d67
Showing 6 changed files with 855 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/content/Plugins/ktor.md
Original file line number Diff line number Diff line change
@@ -117,7 +117,7 @@ See the following comparison:
}
```
=== "SDL"
```
```graphql
type Query {
getSampleData(quantity: Int! = 10): [SampleData!]!
}
Original file line number Diff line number Diff line change
@@ -170,7 +170,7 @@ configure {
}
```

*example*
*Example*

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

Large diffs are not rendered by default.

6 changes: 0 additions & 6 deletions docs/content/assets/hljs/highlight.pack.js

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/assets/hljs/init.js
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
Original file line number Diff line number Diff line change
@@ -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'
@@ -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'
@@ -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:
@@ -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:

0 comments on commit 46b9d67

Please sign in to comment.