https://github.com/morewings/koval-docusaurus
Documentation site for Koval UI
https://github.com/morewings/koval-docusaurus
Last synced: 5 months ago
JSON representation
Documentation site for Koval UI
- Host: GitHub
- URL: https://github.com/morewings/koval-docusaurus
- Owner: morewings
- Created: 2025-10-12T21:23:45.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2026-01-15T02:58:35.000Z (5 months ago)
- Last Synced: 2026-01-15T08:51:41.490Z (5 months ago)
- Language: TypeScript
- Homepage: https://koval.support/
- Size: 4.53 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Koval UI Developer Guide Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Markdown features
Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
## Front Matter
Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
```text title="my-doc.md"
// highlight-start
---
id: my-doc-id
title: My document title
description: My document description
slug: /my-custom-url
---
// highlight-end
## Markdown heading
Markdown text with [links](./hello.md)
```
## Links
Regular Markdown links are supported, using url paths or relative file paths.
```md
Let's see how to [Create a page](/create-a-page).
```
```md
Let's see how to [Create a page](./create-a-page.md).
```
**Result:** Let's see how to [Create a page](./create-a-page.md).
## Images
Regular Markdown images are supported.
You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
```md
```
You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:
```md
```
## Code Blocks
Markdown code blocks are supported with Syntax highlighting.
````md
```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
return
Hello, Docusaurus!
;
}
```
````
```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
return
Hello, Docusaurus!
;
}
```
## Admonitions
Docusaurus has a special syntax to create admonitions and callouts:
```markdown
:::tip My tip
Use this awesome feature option
:::
```
```markdown
:::danger Take care
This action is dangerous
:::
```
```markdown
:::tip My tip
Use this awesome feature option
:::
```
```markdown
:::danger Take care
This action is dangerous
:::
```