Skip to content

Commit dd17728

Browse files
committed
feat: rewriting documentation to integrate to kotlinlang.org
Main branch for documentation rewrite efforts
1 parent 10c7b9d commit dd17728

File tree

4 files changed

+56
-0
lines changed

4 files changed

+56
-0
lines changed

docs-website/cfg/buildprofiles.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<buildprofiles>
4+
<variables>
5+
<enable-browser-edits>true</enable-browser-edits>
6+
<browser-edits-url>https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/</browser-edits-url>
7+
<allow-indexable-eaps>true</allow-indexable-eaps>
8+
</variables>
9+
<build-profile product="serialization"/>
10+
</buildprofiles>

docs-website/serialization.tree

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?xml version='1.0' encoding='utf-8'?>
2+
<!DOCTYPE instance-profile SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
3+
<instance-profile id="serialization" name="Serialization" start-page="serialization.md">
4+
<snippet id="serialization">
5+
<toc-element topic="serialization.md" toc-title="Introduction"/>
6+
<toc-element toc-title="Get started">
7+
<toc-element topic="serialization-get-started.md"/>
8+
<toc-element topic="serialization-serialize-builtin-types.md"/>
9+
<toc-element topic="serialization-customization-options.md"/>
10+
</toc-element>
11+
<toc-element toc-title="Configure JSON serialization">
12+
<toc-element topic="configure-json-serialization.md" toc-title="Overview"/>
13+
<toc-element topic="serialization-json-configuration.md"/>
14+
<toc-element topic="serialization-json-elements.md"/>
15+
<toc-element topic="serialization-transform-json.md" toc-title="JSON transformation"/>
16+
</toc-element>
17+
<toc-element topic="serialization-polymorphism.md"/>
18+
<toc-element toc-title="Custom serializers">
19+
<toc-element topic="create-custom-serializers.md"/>
20+
<toc-element topic="third-party-classes.md"/>
21+
</toc-element>
22+
<toc-element topic="alternative-serialization-formats.md" toc-title="Alternative serialization formats"/>
23+
</snippet>
24+
</instance-profile>

docs-website/v.list

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/stardust/vars.dtd">
3+
4+
<!-- Variables to be used throughout the documentation -->
5+
<vars>
6+
7+
</vars>

docs-website/writerside.cfg

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?xml version='1.0' encoding='utf-8'?>
2+
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
3+
4+
<ihp version="2.0">
5+
<module name="serialization"/>
6+
<topics dir="topics"/>
7+
<images dir="images"/>
8+
<vars src="v.list"/> <!-- be careful with renaming the file, might lead to build errors / bugs -->
9+
<settings>
10+
<!-- ToC within topics, usually displayed on the left, depth is measured by header levels -->
11+
<default-property element-name="chapter" property-name="show-structure-depth" value="2"/>
12+
<wrs-supernova use-version="242.21870"/>
13+
</settings>
14+
<instance src="serialization.tree"/>
15+
</ihp>

0 commit comments

Comments
 (0)