Skip to content

Commit f2ebf70

Browse files
authored
update: kotlinlang documentation switching to Writerside
A collection of changes necessary to build the docs with the new engine.
1 parent 347dd4d commit f2ebf70

File tree

214 files changed

+1711
-1697
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

214 files changed

+1711
-1697
lines changed

docs/cfg/build-script.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!DOCTYPE root
3-
SYSTEM "https://resources.jetbrains.com/stardust/build-script.dtd">
3+
SYSTEM 'https://resources.jetbrains.com/writerside/1.0/build-script.dtd'>
44
<root>
5-
<builds>
6-
<product id="kr" master="project.ihp" family="idea">
7-
<artifact type="web2" name="webHelpKR2.zip" platform="primary" local-update="true" pdf-source="true"/>
8-
</product>
9-
</builds>
10-
</root>
5+
<builds>
6+
<instance id="kr" master="writerside.cfg" family="idea">
7+
<artifact type="web2" name="webHelpKR2.zip" platform="primary" local-update="true" pdf-source="true"/>
8+
</instance>
9+
</builds>
10+
</root>

docs/cfg/buildprofiles.xml

Lines changed: 40 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,41 @@
11
<?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/JetBrains/kotlin-web-site/edit/master/docs/</browser-edits-url>
7-
<browser-edits-url-override
8-
for="coroutines-guide.md,coroutines-basics.md,coroutines-basic-jvm.md,cancellation-and-timeouts.md,composing-suspending-functions.md,coroutine-context-and-dispatchers.md,flow.md,channels.md,exception-handling.md,shared-mutable-state-and-concurrency.md,select-expression.md,debug-coroutines-with-idea.md,debug-flow-with-idea.md">
9-
https://github.com/Kotlin/kotlinx.coroutines/edit/master/docs/topics/
10-
</browser-edits-url-override>
11-
<kotlin-latest-url>%kotlinLatestUrl%</kotlin-latest-url>
12-
<product-web-url>%kotlinLatestUrl%</product-web-url>
13-
<generate-only-default-anchors>true</generate-only-default-anchors>
14-
<web-root>https://kotlinlang.org/docs/</web-root>
15-
<og-image>https://kotlinlang.org/assets/images/open-graph/docs.png</og-image>
16-
<og-twitter>@kotlin</og-twitter>
17-
<web-community-path>Kotlin Community:https://kotlinlang.org/community/</web-community-path>
18-
<download-page/>
19-
<relative-url-to-absolute-prefix>https://github.com/Kotlin/kotlinx.coroutines/blob/master/</relative-url-to-absolute-prefix>
20-
<help-app-version>3</help-app-version>
21-
<config-productid>help/kotlin-reference</config-productid>
22-
<config-disqus-id>jetbrains</config-disqus-id>
23-
<config-disqus-show>true</config-disqus-show>
24-
<config-feedback-enabled>true</config-feedback-enabled>
25-
<config-feedback-widget>true</config-feedback-widget>
26-
<config-feedback-support>https://kotl.in/issue</config-feedback-support>
27-
<config-feedback-url>https://forms-service.jetbrains.com/feedback</config-feedback-url>
28-
<config-webmaster>doc-feedback@kotlinlang.org</config-webmaster>
29-
<config-sideblocks>true</config-sideblocks>
30-
<config-algolia-api-key>1bfad5fdbae302b33d844ed1b43ec4d5</config-algolia-api-key>
31-
<config-algolia-id>7961PKYRXV</config-algolia-id>
32-
<config-algolia-index>prod_KOTLINLANG_WEBHELP</config-algolia-index>
33-
<noindex-content-in-deprecated>true</noindex-content-in-deprecated>
34-
<noindex-content-in-eap>false</noindex-content-in-eap>
35-
<noindex-content-in-release>false</noindex-content-in-release>
36-
<config-search-scopes-provider>https://www.jetbrains.com/search/json/</config-search-scopes-provider>
37-
<custom-favicons>
38-
<![CDATA[
39-
<link rel="icon" href="https://kotlinlang.org/assets/images/favicon.svg?v2" type="image/svg+xml">
40-
<link rel="alternate icon" href="https://kotlinlang.org/assets/images/favicon.ico?v2" type="image/x-icon"/>
41-
<link rel="apple-touch-icon" sizes="57x57" href="https://kotlinlang.org/assets/images/apple-touch-icon.png?v2"/>
42-
<link rel="apple-touch-icon" sizes="72x72" href="https://kotlinlang.org/assets/images/apple-touch-icon-72x72.png?v2"/>
43-
<link rel="apple-touch-icon" sizes="114x114" href="https://kotlinlang.org/assets/images/apple-touch-icon-114x114.png?v2"/>
44-
<link rel="apple-touch-icon" sizes="144x144" href="https://kotlinlang.org/assets/images/apple-touch-icon-144x144.png?v2"/>
45-
<style>a[href="test-page.html"] { visibility: hidden; }</style>
46-
]]>
47-
</custom-favicons>
48-
<generate-canonicals>true</generate-canonicals>
49-
</variables>
50-
<build-profile product="kr"/>
51-
</buildprofiles>
2+
<buildprofiles xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd">
3+
<sitemap priority="0.35" change-frequency="monthly"/>
4+
<variables>
5+
<!--New tags-->
6+
<enable-contribution>true</enable-contribution>
7+
<contribute-url>https://github.com/JetBrains/kotlin-web-site/edit/master/docs/</contribute-url>
8+
<include-in-head>thirdparty/custom-settings.html</include-in-head>
9+
<analytics-head-script-file>thirdparty/dpk-gtm-analytics.html</analytics-head-script-file>
10+
<website-title>%instance% Documentation</website-title>
11+
<automaticLinkSummaries>false</automaticLinkSummaries>
12+
<kotlin-latest-url>%kotlinLatestUrl%</kotlin-latest-url>
13+
<product-web-url>%kotlinLatestUrl%</product-web-url>
14+
<web-root>https://kotlinlang.org/docs/</web-root>
15+
<og-image>https://kotlinlang.org/assets/images/open-graph/docs.png</og-image>
16+
<og-twitter>@kotlin</og-twitter>
17+
<download-page/>
18+
<productid>help/kotlin-reference</productid>
19+
<feedback-widget>true</feedback-widget>
20+
<feedback-support>https://kotl.in/issue</feedback-support>
21+
<feedback-url>https://forms-service.jetbrains.com/feedback</feedback-url>
22+
<webmaster>doc-feedback@kotlinlang.org</webmaster>
23+
<algolia-api-key>1bfad5fdbae302b33d844ed1b43ec4d5</algolia-api-key>
24+
<algolia-id>7961PKYRXV</algolia-id>
25+
<algolia-index>prod_KOTLINLANG_WEBHELP</algolia-index>
26+
<noindex-content>false</noindex-content>
27+
<noindex-content status="eap">false</noindex-content>
28+
<noindex-content status="deprecated">true</noindex-content>
29+
<search-scopes-provider>https://www.jetbrains.com/search/json/</search-scopes-provider>
30+
<!-- <generate-canonicals>true</generate-canonicals>-->
31+
<custom-favicons>
32+
https://kotlinlang.org/assets/images/favicon.svg?v2,
33+
https://kotlinlang.org/assets/images/favicon.ico?v2,
34+
https://kotlinlang.org/assets/images/apple-touch-icon.png?v2,
35+
https://kotlinlang.org/assets/images/apple-touch-icon-72x72.png?v2,
36+
https://kotlinlang.org/assets/images/apple-touch-icon-114x114.png?v2,
37+
https://kotlinlang.org/assets/images/apple-touch-icon-144x144.png?v2
38+
</custom-favicons>
39+
</variables>
40+
<build-profile instance="kr"/>
41+
</buildprofiles>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<style>a[href="test-page.html"] { visibility: hidden; }</style>
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<script>
2+
(function (w, d, s, l, i) {
3+
w[l] = w[l] || [];
4+
w[l].push({'gtm.start': new Date().getTime(), event: 'gtm.js'});
5+
var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != 'dataLayer' ? '&amp;l=' + l : '';
6+
j.async = true;
7+
j.src = '//www.googletagmanager.com/gtm.js?id=' + i + dl;
8+
f.parentNode.insertBefore(j, f);
9+
})(window, document, 'script', 'dataLayer', 'GTM-5P98');
10+
</script>
11+
<script src="https://resources.jetbrains.com/storage/help-app/v6/analytics.js"></script>

0 commit comments

Comments
 (0)