Skip to content

Commit 7874f16

Browse files
author
Retype GitHub Action
committed
Refreshes Retype-generated documentation.
Process triggered by TTangNingzhi.
1 parent c171fea commit 7874f16

File tree

12 files changed

+63
-48
lines changed

12 files changed

+63
-48
lines changed

‎404.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/CodeGRITS">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757052090030">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757068653393">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
@@ -29,11 +29,11 @@
2929
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3030

3131
<link href="/CodeGRITS/favicon.png" rel="icon">
32-
<link href="/CodeGRITS/resources/css/retype.css?v=3.5.0.757052090030" rel="stylesheet">
32+
<link href="/CodeGRITS/resources/css/retype.css?v=3.5.0.757068653393" rel="stylesheet">
3333

34-
<script data-cfasync="false" src="/CodeGRITS/resources/js/config.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
34+
<script data-cfasync="false" src="/CodeGRITS/resources/js/config.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
3535
<script data-cfasync="false" src="/CodeGRITS/resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
36-
<script id="lunr-js" data-cfasync="false" src="/CodeGRITS/resources/js/lunr.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
36+
<script id="lunr-js" data-cfasync="false" src="/CodeGRITS/resources/js/lunr.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
3737
</head>
3838
<body>
3939
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

‎about/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/CodeGRITS">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757052090030">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757068653393">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
@@ -32,11 +32,11 @@
3232
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3333

3434
<link href="../favicon.png" rel="icon">
35-
<link href="../resources/css/retype.css?v=3.5.0.757052090030" rel="stylesheet">
35+
<link href="../resources/css/retype.css?v=3.5.0.757068653393" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
4040
</head>
4141
<body>
4242
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

‎changelog/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/CodeGRITS">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757052090030">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757068653393">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
@@ -32,11 +32,11 @@
3232
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3333

3434
<link href="../favicon.png" rel="icon">
35-
<link href="../resources/css/retype.css?v=3.5.0.757052090030" rel="stylesheet">
35+
<link href="../resources/css/retype.css?v=3.5.0.757068653393" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
4040
</head>
4141
<body>
4242
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

‎data-format/index.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/CodeGRITS">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757052090030">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757068653393">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
@@ -32,12 +32,12 @@
3232
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3333

3434
<link href="../favicon.png" rel="icon">
35-
<link href="../resources/css/retype.css?v=3.5.0.757052090030" rel="stylesheet">
35+
<link href="../resources/css/retype.css?v=3.5.0.757068653393" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
40-
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.5.0.757052090030" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
40+
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.5.0.757068653393" defer></script>
4141
</head>
4242
<body>
4343
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

‎developer/index.html‎

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/CodeGRITS">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757052090030">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757068653393">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
@@ -32,12 +32,12 @@
3232
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3333

3434
<link href="../favicon.png" rel="icon">
35-
<link href="../resources/css/retype.css?v=3.5.0.757052090030" rel="stylesheet">
35+
<link href="../resources/css/retype.css?v=3.5.0.757068653393" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
40-
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.5.0.757052090030" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
40+
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.5.0.757068653393" defer></script>
4141
</head>
4242
<body>
4343
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
@@ -321,6 +321,16 @@ <h3>
321321
<p>We provide a real-time data API for future JetBrains plugin developers and researchers to get real-time data from
322322
IDE tracker and eye tracker separately. The API is based on the <doc-anchor-trigger to="#ide-tracker">IDE Tracker</doc-anchor-trigger>
323323
and <doc-anchor-trigger to="#eye-tracker">Eye Tracker</doc-anchor-trigger>.</p>
324+
<doc-anchor-target id="example-project">
325+
<h4>
326+
<doc-anchor-trigger class="header-anchor-trigger" to="#example-project">#</doc-anchor-trigger>
327+
<span>Example Project</span>
328+
</h4>
329+
</doc-anchor-target>
330+
<p>We provide an example project <a href="https://github.com/codegrits/DataStreamReceiver">DataStreamReceiver</a>
331+
that builds on top of the real-time data API. It is designed to receive real-time IDE tracking and eye tracking data and
332+
directly visualize them in two separate windows. You could refer to the source code of the example project to learn how
333+
to use the API.</p>
324334
<doc-anchor-target id="configuration">
325335
<h3>
326336
<doc-anchor-trigger class="header-anchor-trigger" to="#configuration">#</doc-anchor-trigger>
@@ -337,6 +347,11 @@ <h3>
337347
plugins.set(file(&quot;path-to-CodeGRITS-dependency&quot;))
338348
}</code></pre>
339349
</doc-codeblock></div>
350+
<p>You also need to add the following to <code v-pre>./src/main/resources/META-INF/plugin.xml</code>.</p>
351+
<div class="codeblock-wrapper"><doc-codeblock>
352+
<pre class="language-markup"><code v-pre class="language-markup">
353+
&lt;depends&gt;com.nd.codegrits&lt;/depends&gt;</code></pre>
354+
</doc-codeblock></div>
340355
<doc-anchor-target id="quick-start">
341356
<h3>
342357
<doc-anchor-trigger class="header-anchor-trigger" to="#quick-start">#</doc-anchor-trigger>
@@ -348,13 +363,13 @@ <h3>
348363
the <code v-pre>ideTrackerDataHandler</code> or <code v-pre>eyeTrackerDataHandler</code> to handle the real-time data. Finally, call the <code v-pre>startTracking()</code>
349364
method to start tracking.</p>
350365
<div class="codeblock-wrapper"><doc-codeblock>
351-
<pre class="language-java"><code v-pre class="language-java">IDETracker ideTracker = IDETracker.getInstance();
352-
ideTracker.setIsRealTimeDataTransmitting(true);
353-
ideTracker.setIdeTrackerDataHandler(element -&gt; {
354-
String formattedStr = &quot;Event: &quot; + element.getAttribute(&quot;id&quot;);
355-
System.out.println(formattedStr);
356-
});
357-
ideTracker.startTracking(currentProject);</code></pre>
366+
<pre class="language-java"><code v-pre class="language-java">IDETracker ideTracker=IDETracker.getInstance();
367+
ideTracker.setIsRealTimeDataTransmitting(true);
368+
ideTracker.setIdeTrackerDataHandler(element-&gt;{
369+
String formattedStr=&quot;Event: &quot;+element.getAttribute(&quot;id&quot;);
370+
System.out.println(formattedStr);
371+
});
372+
ideTracker.startTracking(currentProject);</code></pre>
358373
</doc-codeblock></div>
359374
<div class="flex mb-6">
360375
<div class="shrink-0 w-1 rounded-tl rounded-bl bg-blue-500 dark:bg-blue-400"></div>

‎faq/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/CodeGRITS">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757052090030">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757068653393">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
@@ -32,11 +32,11 @@
3232
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3333

3434
<link href="../favicon.png" rel="icon">
35-
<link href="../resources/css/retype.css?v=3.5.0.757052090030" rel="stylesheet">
35+
<link href="../resources/css/retype.css?v=3.5.0.757068653393" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
4040
</head>
4141
<body>
4242
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

‎index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/CodeGRITS">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757052090030">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757068653393">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
@@ -32,11 +32,11 @@
3232
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3333

3434
<link href="favicon.png" rel="icon">
35-
<link href="resources/css/retype.css?v=3.5.0.757052090030" rel="stylesheet">
35+
<link href="resources/css/retype.css?v=3.5.0.757068653393" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="resources/js/config.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="resources/js/config.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="resources/js/lunr.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="resources/js/lunr.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
4040
</head>
4141
<body>
4242
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

‎license/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
66
<meta name="turbo-root" content="/CodeGRITS">
7-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757052090030">
7+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757068653393">
88

99
<!-- See retype.com -->
1010
<meta name="generator" content="Retype 3.5.0">
@@ -32,11 +32,11 @@
3232
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3333

3434
<link href="../favicon.png" rel="icon">
35-
<link href="../resources/css/retype.css?v=3.5.0.757052090030" rel="stylesheet">
35+
<link href="../resources/css/retype.css?v=3.5.0.757068653393" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757052090030" data-turbo-eval="false" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757068653393" data-turbo-eval="false" defer></script>
4040
</head>
4141
<body>
4242
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

0 commit comments

Comments
 (0)