Skip to content

Commit

Permalink
feat: improve documentation (#15)
Browse files Browse the repository at this point in the history 
Signed-off-by: Steven E Wright <StevenEWright@users.noreply.github.com>
  • Loading branch information
@StevenEWright
StevenEWright committed Aug 11, 2023
1 parent 812c9bf commit 5a085ca
Show file tree
Hide file tree
Showing 7 changed files with 104 additions and 360 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<p align="center">
<a href="https://editor.kullna.org/demo.html">🔍 Demos</a> •
<a href="https://editor.kullna.org/modules.html">📖 Docs</a> •
<a href="https://editor.kullna.org/CONTRIBUTING.html">🙌 Contribute</a>
<a href="https://editor.kullna.org/pages/CONTRIBUTING.html">🙌 Contribute</a>
</p>
<p align="center">
<a href="https://cdn.jsdelivr.net/npm/@kullna/editor/dist/kullna-editor.min.js">
Expand Down Expand Up @@ -81,7 +81,7 @@ We envision a community-driven evolution for `@kullna/editor`. Your feedback, id
contributions can shape the future of this editor, making it even more versatile and user-friendly.
If our vision resonates with yours, consider contributing.

👉 [Read the Contributing Page](https://editor.kullna.org/CONTRIBUTING.html) for more details.
👉 [Read the Contributing Page](https://editor.kullna.org/pages/CONTRIBUTING.html) for more details.

---

Expand Down
233 changes: 12 additions & 221 deletions docs.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,14 @@ h2 {
line-height: 1.5em;
}

code {
background-color: var(--sd-base3);
}

pre > code {
background-color: var(--sd-base02);
}

pre,
pre > code {
background-color: var(--sd-base02);
Expand All @@ -181,227 +189,10 @@ pre > code {
pre {
box-shadow: rgba(0, 0, 0, 0.24) 0px 3px 8px;
}

:root {
--light-hl-0: var(--sd-violet);
--dark-hl-0: var(--sd-violet);
--light-hl-1: var(--sd-base1);
--dark-hl-1: #d4d4d4;
--light-hl-2: var(--sd-base1);
--dark-hl-2: var(--sd-red);
--light-hl-3: var(--sd-red);
--dark-hl-3: #ce9178;
--light-hl-4: var(--sd-violet);
--dark-hl-4: var(--sd-blue);
--light-hl-5: var(--sd-green);
--dark-hl-5: var(--sd-cyan);
--light-hl-6: var(--sd-base3);
--dark-hl-6: var(--sd-green);
--light-hl-7: var(--sd-yellow);
--dark-hl-7: #dcdcaa;
--light-hl-8: var(--sd-red);
--dark-hl-8: #d7ba7d;
--light-hl-9: var(--sd-base1);
--dark-hl-9: var(--sd-blue);
--light-hl-10: var(--sd-green);
--dark-hl-10: var(--sd-green);
--light-hl-11: #811f3f;
--dark-hl-11: #d16969;
--light-hl-12: #d16969;
--dark-hl-12: #ce9178;
--light-hl-13: var(--sd-red);
--dark-hl-13: #dcdcaa;
--light-hl-14: var(--sd-base1);
--dark-hl-14: #808080;
--light-hl-15: var(--sd-red);
--dark-hl-15: var(--sd-blue);
--light-hl-16: var(--sd-red);
--dark-hl-16: var(--sd-red);
--light-hl-17: var(--sd-blue);
--dark-hl-17: #ce9178;
--light-hl-18: var(--sd-base1);
--dark-hl-18: #d4d4d4;
--light-hl-19: var(--sd-yellow);
--dark-hl-19: #d7ba7d;
--light-hl-20: var(--sd-blue);
--dark-hl-20: #ce9178;
--light-hl-21: #000000;
--dark-hl-21: #c8c8c8;
--light-code-background: #ffffff;
--dark-code-background: #1e1e1e;
}

@media (prefers-color-scheme: light) {
:root {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
--hl-10: var(--light-hl-10);
--hl-11: var(--light-hl-11);
--hl-12: var(--light-hl-12);
--hl-13: var(--light-hl-13);
--hl-14: var(--light-hl-14);
--hl-15: var(--light-hl-15);
--hl-16: var(--light-hl-16);
--hl-17: var(--light-hl-17);
--hl-18: var(--light-hl-18);
--hl-19: var(--light-hl-19);
--hl-20: var(--light-hl-20);
--hl-21: var(--light-hl-21);
--code-background: var(--light-code-background);
}
}

@media (prefers-color-scheme: dark) {
:root {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
--hl-10: var(--dark-hl-10);
--hl-11: var(--dark-hl-11);
--hl-12: var(--dark-hl-12);
--hl-13: var(--dark-hl-13);
--hl-14: var(--dark-hl-14);
--hl-15: var(--dark-hl-15);
--hl-16: var(--dark-hl-16);
--hl-17: var(--dark-hl-17);
--hl-18: var(--dark-hl-18);
--hl-19: var(--dark-hl-19);
--hl-20: var(--dark-hl-20);
--hl-21: var(--dark-hl-21);
--code-background: var(--dark-code-background);
}
}

:root[data-theme='light'] {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
--hl-10: var(--light-hl-10);
--hl-11: var(--light-hl-11);
--hl-12: var(--light-hl-12);
--hl-13: var(--light-hl-13);
--hl-14: var(--light-hl-14);
--hl-15: var(--light-hl-15);
--hl-16: var(--light-hl-16);
--hl-17: var(--light-hl-17);
--hl-18: var(--light-hl-18);
--hl-19: var(--light-hl-19);
--hl-20: var(--light-hl-20);
--hl-21: var(--light-hl-21);
--code-background: var(--light-code-background);
}

:root[data-theme='dark'] {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
--hl-10: var(--dark-hl-10);
--hl-11: var(--dark-hl-11);
--hl-12: var(--dark-hl-12);
--hl-13: var(--dark-hl-13);
--hl-14: var(--dark-hl-14);
--hl-15: var(--dark-hl-15);
--hl-16: var(--dark-hl-16);
--hl-17: var(--dark-hl-17);
--hl-18: var(--dark-hl-18);
--hl-19: var(--dark-hl-19);
--hl-20: var(--dark-hl-20);
--hl-21: var(--dark-hl-21);
--code-background: var(--dark-code-background);
code.tsd-tag {
border: 0px;
}

.hl-0 {
color: var(--hl-0);
}
.hl-1 {
color: var(--hl-1);
}
.hl-2 {
color: var(--hl-2);
}
.hl-3 {
color: var(--hl-3);
}
.hl-4 {
color: var(--hl-4);
}
.hl-5 {
color: var(--hl-5);
}
.hl-6 {
color: var(--hl-6);
}
.hl-7 {
color: var(--hl-7);
}
.hl-8 {
color: var(--hl-8);
}
.hl-9 {
color: var(--hl-9);
}
.hl-10 {
color: var(--hl-10);
}
.hl-11 {
color: var(--hl-11);
}
.hl-12 {
color: var(--hl-12);
}
.hl-13 {
color: var(--hl-13);
}
.hl-14 {
color: var(--hl-14);
}
.hl-15 {
color: var(--hl-15);
}
.hl-16 {
color: var(--hl-16);
}
.hl-17 {
color: var(--hl-17);
}
.hl-18 {
color: var(--hl-18);
}
.hl-19 {
color: var(--hl-19);
}
.hl-20 {
color: var(--hl-20);
}
.hl-21 {
color: var(--hl-21);
hr {
margin-top: 4rem;
}
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"website:gen": "./website",
"website": "npm run website:gen && cd ./docs/ && web-dev-server --app-index ./index.html --node-resolve --open",
"document": "npm run document:gen && cd ./docs/ && web-dev-server --app-index ./index.html --node-resolve --open",
"document:gen": "node generatePackageMetadata.js && typedoc ./src/index.ts --disableSources --hideGenerator --titleLink \"/modules.html\"",
"document:gen": "node generatePackageMetadata.js && typedoc ./src/index.ts --disableSources --hideGenerator --darkHighlightTheme solarized-dark --lightHighlightTheme solarized-dark --titleLink \"/modules.html\"",
"size": "size-limit",
"lint:ts": "eslint ./src/**/*.ts",
"lint:prettier": "prettier . --check",
Expand Down
Loading

0 comments on commit 5a085ca

Please sign in to comment.