Skip to content

Commit 5e56a65

Browse files
committed
refactor: πŸ’‘ Docs files moved to the docs root
1 parent d67ae04 commit 5e56a65

File tree

14 files changed

+28
-48
lines changed

14 files changed

+28
-48
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

β€Ždocs/docs/.nojekyll

Whitespace-only changes.

β€Ždocs/docs/sidebar.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
File renamed without changes.

β€Ždocs/index.html

Lines changed: 17 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8" />
55
<title>WindingTree Market Protocol SDK</title>
66
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7-
<link rel="icon" href="build/favicon.png" />
7+
<link rel="icon" href="/assets/favicon.png" />
88
<meta
99
name="description"
1010
content="WindingTree Market Protocol SDK Documentation Site"
@@ -21,20 +21,6 @@
2121
rel="stylesheet"
2222
href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css"
2323
/>
24-
<!-- Google Tag Manager -->
25-
<script>
26-
(function (w, d, s, l, i) {
27-
w[l] = w[l] || [];
28-
w[l].push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' });
29-
var f = d.getElementsByTagName(s)[0],
30-
j = d.createElement(s),
31-
dl = l != 'dataLayer' ? '&l=' + l : '';
32-
j.async = true;
33-
j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
34-
f.parentNode.insertBefore(j, f);
35-
})(window, document, 'script', 'dataLayer', 'TBD');
36-
</script>
37-
<!-- End Google Tag Manager -->
3824
<style>
3925
.app-name-link img {
4026
max-width: 90%;
@@ -53,43 +39,37 @@
5339
el: '#main',
5440
name: 'WindingTree Market Protocol SDK',
5541
repo: 'https://github.com/windingtree/sdk.git',
56-
homepage: 'docs/index.md',
57-
loadSidebar: 'docs/sidebar.md',
42+
homepage: 'index.md',
43+
loadSidebar: 'sidebar.md',
5844
maxLevel: 4,
5945
subMaxLevel: 3,
6046
relativePath: true,
6147
auto2top: true,
6248
logo: 'assets/wt-logo-wide.png',
6349
noEmoji: true,
64-
mermaidConfig: {
65-
querySelector: ".mermaid"
66-
},
50+
plugins: [
51+
function (hook) {
52+
hook.doneEach(function () {
53+
let mermaidConfig = {
54+
querySelector: ".mermaid",
55+
suppressErrors: true,
56+
};
57+
mermaid.run(mermaidConfig);
58+
});
59+
},
60+
],
6761
};
6862
</script>
69-
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
70-
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
7163
<script type="module">
72-
import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
64+
import mermaid from "//cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
7365
mermaid.initialize({ startOnLoad: true });
7466
window.mermaid = mermaid;
7567
</script>
68+
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
69+
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
7670
<script src="//unpkg.com/docsify-mermaid@2.0.0/dist/docsify-mermaid.js"></script>
7771
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
7872
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-json.min.js"></script>
7973
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"></script>
80-
<script>
81-
var num = 0;
82-
mermaid.initialize({ startOnLoad: false });
83-
</script>
84-
<!-- Google Tag Manager (noscript) -->
85-
<noscript
86-
><iframe
87-
src="https://www.googletagmanager.com/ns.html?id=TBD"
88-
height="0"
89-
width="0"
90-
style="display: none; visibility: hidden"
91-
></iframe
92-
></noscript>
93-
<!-- End Google Tag Manager (noscript) -->
9474
</body>
9575
</html>

β€Ždocs/docs/index.md renamed to β€Ždocs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ This setup provides the basic configuration for a protocol client. Depending on
150150

151151
- [WindingTree protocol discussions](https://github.com/windingtree/sdk/discussions)
152152
- Bug tracker: [https://github.com/windingtree/sdk/issues](https://github.com/windingtree/sdk/issues)
153-
- [Contribution](/docs/contribution.md)
153+
- [Contribution](contribution.md)
154154

155155
Please keep in mind that the SDK is currently in beta, and libraries may be unstable with APIs subject to change. As you explore the functionalities and contribute to the development, we encourage you to participate in the discussions and provide valuable feedback to help improve the SDK's stability and performance. If you encounter any issues or have questions during your development journey, do not hesitate to reach out to our support team, who are available to assist you at every step.
156156

File renamed without changes.
File renamed without changes.

β€Ždocs/sidebar.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!-- markdownlint-disable MD041 -->
2+
3+
- [Getting started](/)
4+
- [Protocol overview](protocol.md)
5+
- [Coordination server](coordinator.md)
6+
- [Clients](clients.md)
7+
- [Nodes](nodes.md)
8+
- [Storage](storage.md)
9+
- [Availability management](availability.md)
10+
- [Contribution](contribution.md)
File renamed without changes.

0 commit comments

Comments
Β (0)