Convert html to md
This commit is contained in:
parent
21008f9f02
commit
8a19d974f8
|
|
@ -1,12 +0,0 @@
|
||||||
<section class="kdl-section" id="description">
|
|
||||||
<p>
|
|
||||||
kdl is a document language, mostly based on
|
|
||||||
<a href="https://sdlang.org/">SDLang</a>, with xml-like semantics that looks
|
|
||||||
like you're invoking a bunch of CLI commands!
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
It's meant to be used both as a serialization format and a configuration
|
|
||||||
language, and is relatively light on syntax compared to XML.
|
|
||||||
</p>
|
|
||||||
</section>
|
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
<section class="kdl-section" id="description">
|
||||||
|
|
||||||
|
kdl is a document language, mostly based on
|
||||||
|
[SDLang](https://sdlang.org), with xml-like semantics that looks
|
||||||
|
like you're invoking a bunch of CLI commands!
|
||||||
|
|
||||||
|
It's meant to be used both as a serialization format and a configuration
|
||||||
|
language, and is relatively light on syntax compared to XML.
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
<section class="kdl-section" id="design-and-discussion">
|
|
||||||
<h2>Design and Discussion</h2>
|
|
||||||
<p>
|
|
||||||
kdl is still extremely new, and discussion about the format should happen
|
|
||||||
over on the
|
|
||||||
<a href="https://github.com/kdoclang/kdl/discussions">discussions</a> page
|
|
||||||
in the Github repo. Feel free to jump in and give us your 2 cents!
|
|
||||||
</p>
|
|
||||||
</section>
|
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
<section class="kdl-section" id="design-and-discussion">
|
||||||
|
|
||||||
|
## Design and Discussion
|
||||||
|
|
||||||
|
kdl is still extremely new, and discussion about the format should happen
|
||||||
|
over on the
|
||||||
|
[discussions](https://github.com/kdoclang/kdl/discussions) page
|
||||||
|
in the Github repo. Feel free to jump in and give us your 2 cents!
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
<section class="kdl-section" id="design-principles">
|
|
||||||
<h2>Design Principles</h2>
|
|
||||||
<ol>
|
|
||||||
<li>Maintainability</li>
|
|
||||||
<li>Flexibility</li>
|
|
||||||
<li>Cognitive simplicity and Learnability</li>
|
|
||||||
<li>Ease of de/serialization</li>
|
|
||||||
<li>Ease of implementation</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
These are the guiding principles behind the design of KDL, in order of
|
|
||||||
importance. These principles will hopefully be useful in tie-breaking and
|
|
||||||
otherwise directing specific decisions when it comes down to it. They are
|
|
||||||
intentionally vague when it comes to specifics, but more concrete
|
|
||||||
definitions for each one will be settled on as the project matures.
|
|
||||||
</p>
|
|
||||||
</section>
|
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
<section class="kdl-section" id="design-principles">
|
||||||
|
|
||||||
|
## Design Principles
|
||||||
|
|
||||||
|
1. Maintainability
|
||||||
|
1. Flexibility
|
||||||
|
1. Cognitive simplicity and Learnability
|
||||||
|
1. Ease of de/serialization
|
||||||
|
1. Ease of implementation
|
||||||
|
|
||||||
|
These are the guiding principles behind the design of KDL, in order of
|
||||||
|
importance. These principles will hopefully be useful in tie-breaking and
|
||||||
|
otherwise directing specific decisions when it comes down to it. They are
|
||||||
|
intentionally vague when it comes to specifics, but more concrete
|
||||||
|
definitions for each one will be settled on as the project matures.
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
@ -1,10 +1,10 @@
|
||||||
<section class="kdl-section" id="overview">
|
<section class="kdl-section" id="overview">
|
||||||
<h2>Overview</h2>
|
|
||||||
|
|
||||||
<p>The basic syntax is similar to SDLang:</p>
|
## Overview
|
||||||
|
|
||||||
<pre>
|
The basic syntax is similar to SDLang:
|
||||||
<code>
|
|
||||||
|
```kdl
|
||||||
// This is a node with a single string value
|
// This is a node with a single string value
|
||||||
title "Hello, World"
|
title "Hello, World"
|
||||||
|
|
||||||
|
|
@ -35,13 +35,11 @@ C style multiline
|
||||||
*/
|
*/
|
||||||
|
|
||||||
tag /*foo=true*/ bar=false
|
tag /*foo=true*/ bar=false
|
||||||
</code>
|
```
|
||||||
</pre>
|
|
||||||
|
|
||||||
<p>But kdl changes a few details:</p>
|
But kdl changes a few details:
|
||||||
|
|
||||||
<pre>
|
```kdl
|
||||||
<code>
|
|
||||||
// Files must be utf8 encoded!
|
// Files must be utf8 encoded!
|
||||||
smile "😁"
|
smile "😁"
|
||||||
|
|
||||||
|
|
@ -94,20 +92,18 @@ mynode /-"commented" "not commented" /-key="value" /-{
|
||||||
a
|
a
|
||||||
b
|
b
|
||||||
}
|
}
|
||||||
</code>
|
```
|
||||||
</pre>
|
|
||||||
|
|
||||||
<p>The following SDLang features are removed altogether:</p>
|
The following SDLang features are removed altogether:
|
||||||
|
|
||||||
|
- "Anonymous" nodes
|
||||||
|
- Binary data literals
|
||||||
|
- Date/time formats
|
||||||
|
- `on` and `off` booleans
|
||||||
|
- Backtick strings
|
||||||
|
- Semicolons
|
||||||
|
- Namespaces with `:`
|
||||||
|
- Shell style (`#`) and Lua style (`--`) comments
|
||||||
|
- Distinction between 32/64/128-bit numbers. There's just numbers.
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>"Anonymous" nodes</li>
|
|
||||||
<li>Binary data literals</li>
|
|
||||||
<li>Date/time formats</li>
|
|
||||||
<li><code>on</code> and <code>off</code> booleans</li>
|
|
||||||
<li>Backtick strings</li>
|
|
||||||
<li>Semicolons</li>
|
|
||||||
<li>Namespaces with <code>:</code></li>
|
|
||||||
<li>Shell style (<code>#</code>) and Lua style (<code>--</code>) comments</li>
|
|
||||||
<li>Distinction between 32/64/128-bit numbers. There's just numbers.</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
</section>
|
||||||
|
|
@ -7,8 +7,7 @@ title: kdl - Kat's Document Language
|
||||||
<h1 class="text-4xl text-center">kdl - Kat's Document Language</h1>
|
<h1 class="text-4xl text-center">kdl - Kat's Document Language</h1>
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
|
{% include partials/description.md %}
|
||||||
{% include partials/description.html %}
|
{% include partials/design-and-discussion.md %}
|
||||||
{% include partials/design-and-discussion.html %}
|
{% include partials/design-principles.md %}
|
||||||
{% include partials/design-principles.html %}
|
{% include partials/overview.md %}
|
||||||
{% include partials/overview.html %}
|
|
||||||
Loading…
Reference in New Issue