update documentation after publishing to npm

Jirkasa · Sep 14, 2024 · 077b4e9 · 077b4e9
1 parent af7fa88
commit 077b4e9
Show file tree

Hide file tree

Showing 34 changed files with 34 additions and 42 deletions.
diff --git a/pages/documentation/code-view/includes/create-code-view-example.ejs b/pages/documentation/code-view/includes/create-code-view-example.ejs
@@ -24,7 +24,7 @@ console.log("result: " + result);&lt;/code&gt;&lt;/pre&gt;</code></pre>
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "@jirkasa/code-box";
 
 new CodeView(document.getElementById("MyCodeView"), {
     highlight: "1-2,6"

diff --git a/pages/documentation/creators/includes/code-box-identifiers-example.ejs b/pages/documentation/creators/includes/code-box-identifiers-example.ejs
@@ -28,7 +28,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBoxCreator } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBoxCreator } from "@jirkasa/code-box";
 
 const codeBoxCreator = new TabCodeBoxCreator({
     svgSpritePath: "./img/icon-sprite.svg",

diff --git a/pages/documentation/creators/includes/code-view-creator-example.ejs b/pages/documentation/creators/includes/code-view-creator-example.ejs
@@ -29,7 +29,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;</code></pre>
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeViewCreator } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeViewCreator } from "@jirkasa/code-box";
 
 const codeViewCreator = new CodeViewCreator();
 codeViewCreator.create("[data-my-code-view]");</code></pre>

diff --git a/pages/documentation/creators/includes/code-view-identifiers-example.ejs b/pages/documentation/creators/includes/code-view-identifiers-example.ejs
@@ -22,7 +22,7 @@ console.log("result: " + (x + y));&lt;/code&gt;&lt;/pre&gt;</code></pre>
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeViewCreator } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeViewCreator } from "@jirkasa/code-box";
 
 const codeViewCreator = new CodeViewCreator();
 codeViewCreator.create("[data-my-code-view]");

diff --git a/pages/documentation/creators/includes/project-code-box-creator-example.ejs b/pages/documentation/creators/includes/project-code-box-creator-example.ejs
@@ -28,7 +28,7 @@ console.log("result: " + (x + y));&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBoxCreator } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBoxCreator } from "@jirkasa/code-box";
 
 const codeBoxCreator = new ProjectCodeBoxCreator({
     minCodeViewLinesCount: 10,

diff --git a/pages/documentation/creators/includes/project-code-box-inheritance-example.ejs b/pages/documentation/creators/includes/project-code-box-inheritance-example.ejs
@@ -34,7 +34,7 @@ console.log("result: " + (x + y));&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBoxCreator } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBoxCreator } from "@jirkasa/code-box";
 
 const codeBoxCreator = new ProjectCodeBoxCreator({
     minCodeViewLinesCount: 10,

diff --git a/pages/documentation/creators/includes/tab-code-box-creator-example.ejs b/pages/documentation/creators/includes/tab-code-box-creator-example.ejs
@@ -28,7 +28,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBoxCreator } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBoxCreator } from "@jirkasa/code-box";
 
 const codeBoxCreator = new TabCodeBoxCreator({
     svgSpritePath: "./img/icon-sprite.svg",

diff --git a/pages/documentation/creators/includes/virtual-code-box-creator-example.ejs b/pages/documentation/creators/includes/virtual-code-box-creator-example.ejs
@@ -28,7 +28,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { VirtualCodeBoxCreator } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { VirtualCodeBoxCreator } from "@jirkasa/code-box";
 
 const codeBoxCreator = new VirtualCodeBoxCreator();
 codeBoxCreator.create("[data-my-code-box]");</code></pre>

diff --git a/pages/documentation/getting-started/includes/create-code-view.ejs b/pages/documentation/getting-started/includes/create-code-view.ejs
@@ -22,7 +22,7 @@ console.log("result: " + (x + y));&lt;/code&gt;&lt;/pre&gt;</code></pre>
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "@jirkasa/code-box";
 
 new CodeView(document.getElementById("MyCodeView"));</code></pre>
     </div>

diff --git a/pages/documentation/getting-started/includes/create-project-code-box.ejs b/pages/documentation/getting-started/includes/create-project-code-box.ejs
@@ -28,7 +28,7 @@ console.log("result: " + (x + y));&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "@jirkasa/code-box";
 
 new ProjectCodeBox(document.getElementById("MyProjectCodeBox"), {
     minCodeViewLinesCount: 10,

diff --git a/pages/documentation/getting-started/includes/create-tab-code-box.ejs b/pages/documentation/getting-started/includes/create-tab-code-box.ejs
@@ -28,7 +28,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "@jirkasa/code-box";
 
 new TabCodeBox(document.getElementById("MyTabCodeBox"), {
     svgSpritePath: "./img/icon-sprite.svg",

diff --git a/pages/documentation/getting-started/includes/import-core-styles.ejs b/pages/documentation/getting-started/includes/import-core-styles.ejs
@@ -1,3 +1,3 @@
 <div class="code-example u-mb-6">
-    <pre class="code-example__code"><code class="language-css">@import "code-box/style.min.css";</code></pre>
+    <pre class="code-example__code"><code class="language-css">@import "@jirkasa/code-box/dist/style.min.css";</code></pre>
 </div>
diff --git a/pages/documentation/getting-started/includes/npm-installation.ejs b/pages/documentation/getting-started/includes/npm-installation.ejs
@@ -1,3 +1,3 @@
 <div class="code-example u-mb-2">
-    <pre class="code-example__code"><code class="no-highlight">npm install code-box --save</code></pre>
+    <pre class="code-example__code"><code class="no-highlight">npm install @jirkasa/code-box --save</code></pre>
 </div>
diff --git a/pages/documentation/getting-started/includes/tab-code-box-creator.ejs b/pages/documentation/getting-started/includes/tab-code-box-creator.ejs
@@ -39,7 +39,7 @@ let strings = ["code", "box"];&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBoxCreator } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBoxCreator } from "@jirkasa/code-box";
 
 const creator = new TabCodeBoxCreator({
     svgSpritePath: "./img/icon-sprite.svg",

diff --git a/pages/documentation/getting-started/index.ejs b/pages/documentation/getting-started/index.ejs
@@ -6,7 +6,6 @@
         <h2 id="installation" class="u-mb-2">Installation</h2>
         <p class="u-mb-2">Code box is installed via NPM like any other package.</p>
         <%- include("./includes/npm-installation.ejs") %>
-        <!-- TODO - potom to zkusit naimportovat a upravit ukázku kódu -->
         <p class="u-mb-2">After installation, you need to integrate the core CSS styles into your project. If you're using a CSS preprocessor, you can import the styles as shown below. If you're not using a preprocessor, simply copy the CSS file from the node_modules folder.</p>
         <%- include("./includes/import-core-styles.ejs") %>
         <h2 id="usage-example" class="u-mb-2">Usage Example</h2>

diff --git a/pages/documentation/other-components/includes/code-box-memento-example.ejs b/pages/documentation/other-components/includes/code-box-memento-example.ejs
@@ -28,7 +28,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "@jirkasa/code-box";
 
 const codeBox = new TabCodeBox(document.getElementById("MyCodeBox"), {
     lazyInit: false,

diff --git a/pages/documentation/other-components/includes/code-view-memento-example.ejs b/pages/documentation/other-components/includes/code-view-memento-example.ejs
@@ -24,7 +24,7 @@ console.log("result: " + result);&lt;/code&gt;&lt;/pre&gt;</code></pre>
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "@jirkasa/code-box";
 
 const codeView = new CodeView(document.getElementById("MyCodeView"));
 

diff --git a/pages/documentation/other-components/includes/highlight-box-example.ejs b/pages/documentation/other-components/includes/highlight-box-example.ejs
@@ -24,7 +24,7 @@ console.log("result: " + result);&lt;/code&gt;&lt;/pre&gt;</code></pre>
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "@jirkasa/code-box";
 
 const codeView = new CodeView(document.getElementById("MyCodeView"));
 

diff --git a/pages/documentation/project-code-box/includes/create-project-code-box.ejs b/pages/documentation/project-code-box/includes/create-project-code-box.ejs
@@ -60,7 +60,7 @@ public class MyApp {
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "@jirkasa/code-box";
 
 new ProjectCodeBox(document.getElementById("MyProjectCodeBox"), {
     minCodeViewLinesCount: 20,

diff --git a/pages/documentation/project-code-box/includes/project-code-box-inheritance-example.ejs b/pages/documentation/project-code-box/includes/project-code-box-inheritance-example.ejs
@@ -33,7 +33,7 @@ console.log("result: " + (x + y));&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "@jirkasa/code-box";
 
 const codeBox1 = new ProjectCodeBox(document.getElementById("CodeBox1"), {
     minCodeViewLinesCount: 10,

diff --git a/pages/documentation/tab-code-box/includes/create-tab-code-box-example.ejs b/pages/documentation/tab-code-box/includes/create-tab-code-box-example.ejs
@@ -30,7 +30,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "@jirkasa/code-box";
 
 new TabCodeBox(document.getElementById("MyTabCodeBox"), {
     svgSpritePath: "./img/icon-sprite.svg",

diff --git a/pages/documentation/virtual-code-box/includes/create-virtual-code-box-example.ejs b/pages/documentation/virtual-code-box/includes/create-virtual-code-box-example.ejs
@@ -28,7 +28,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { VirtualCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { VirtualCodeBox } from "@jirkasa/code-box";
 
 new VirtualCodeBox(document.getElementById("MyVirtualCodeBox"));</code></pre>
     </div>

diff --git a/pages/examples/includes/highlighting.ejs b/pages/examples/includes/highlighting.ejs
@@ -24,7 +24,7 @@ console.log("result: " + result);&lt;/code&gt;&lt;/pre&gt;</code></pre>
         <span>JavaScript</span>
     </button>
     <div data-collapsible-closed class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "@jirkasa/code-box";
 
 new CodeView(document.getElementById("MyCodeView"), {
     highlight: "1-2,6"

diff --git a/pages/examples/includes/project-code-box-inheritance.ejs b/pages/examples/includes/project-code-box-inheritance.ejs
@@ -37,7 +37,7 @@ console.log("result: " + (x + y));&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div data-collapsible-closed class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "@jirkasa/code-box";
 
 const codeBox1 = new ProjectCodeBox(document.getElementById("CodeBox1"), {
     minCodeViewLinesCount: 10,

diff --git a/pages/examples/includes/project-code-box.ejs b/pages/examples/includes/project-code-box.ejs
@@ -60,7 +60,7 @@ public class MyApp {
         <span>JavaScript</span>
     </button>
     <div data-collapsible-closed class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "@jirkasa/code-box";
 
 new ProjectCodeBox(document.getElementById("MyProjectCodeBox"), {
     minCodeViewLinesCount: 20,

diff --git a/pages/examples/includes/simple-code-view.ejs b/pages/examples/includes/simple-code-view.ejs
@@ -22,7 +22,7 @@ console.log("result: " + (x + y));&lt;/code&gt;&lt;/pre&gt;</code></pre>
         <span>JavaScript</span>
     </button>
     <div data-collapsible-closed class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "@jirkasa/code-box";
 
 new CodeView(document.getElementById("MyCodeView"));</code></pre>
     </div>

diff --git a/pages/examples/includes/styling-code-view.ejs b/pages/examples/includes/styling-code-view.ejs
@@ -24,7 +24,7 @@ console.log("result: " + result);&lt;/code&gt;&lt;/pre&gt;</code></pre>
         <span>JavaScript</span>
     </button>
     <div data-collapsible-closed class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "@jirkasa/code-box";
 
 new CodeView(document.getElementById("MyCodeView"), {
     highlight: "4"

diff --git a/pages/examples/includes/styling-project-code-box.ejs b/pages/examples/includes/styling-project-code-box.ejs
@@ -60,7 +60,7 @@ public class MyApp {
         <span>JavaScript</span>
     </button>
     <div data-collapsible-closed class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { ProjectCodeBox } from "@jirkasa/code-box";
 
 new ProjectCodeBox(document.getElementById("MyProjectCodeBox"), {
     minCodeViewLinesCount: 20,

diff --git a/pages/examples/includes/styling-tab-code-box.ejs b/pages/examples/includes/styling-tab-code-box.ejs
@@ -30,7 +30,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div data-collapsible-closed class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "@jirkasa/code-box";
 
 new TabCodeBox(document.getElementById("MyTabCodeBox"), {
     svgSpritePath: "./img/icon-sprite.svg",

diff --git a/pages/examples/includes/tab-code-box.ejs b/pages/examples/includes/tab-code-box.ejs
@@ -30,7 +30,7 @@ console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
         <span>JavaScript</span>
     </button>
     <div data-collapsible-closed class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { TabCodeBox } from "@jirkasa/code-box";
 
 new TabCodeBox(document.getElementById("MyTabCodeBox"), {
     svgSpritePath: "./img/icon-sprite.svg",

diff --git a/pages/examples/includes/visualization-of-code-execution.ejs b/pages/examples/includes/visualization-of-code-execution.ejs
@@ -28,7 +28,7 @@ while (counter >= 0) {
         <span>JavaScript</span>
     </button>
     <div data-collapsible-closed class="code-example__collapsible">
-        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "code-box";
+        <pre class="code-example__code"><code class="language-javascript">import { CodeView } from "@jirkasa/code-box";
 
 const codeView = new CodeView(document.getElementById("MyCodeView"));
 

diff --git a/pages/home-page-code-boxes/tab-code-box.ejs b/pages/home-page-code-boxes/tab-code-box.ejs
@@ -12,7 +12,7 @@ let string2 = " string.";
 console.log(string1 + string2);&lt;/code&gt;&lt;/pre&gt;
 
 &lt;/div&gt;</code></pre>
-    <pre data-cb-name="JavaScript"><code class="no-highlight">import { TabCodeBox } from "code-box";
+    <pre data-cb-name="JavaScript"><code class="no-highlight">import { TabCodeBox } from "@jirkasa/code-box";
 
 new TabCodeBox(document.getElementById("MyCodeBox"), {
     svgSpritePath: "./img/icon-sprite.svg",

diff --git a/pages/includes/header.ejs b/pages/includes/header.ejs
@@ -11,7 +11,7 @@
                     <li><a href="<%= pathToRootFolder %>examples/" class="header__navigation-link <% if (locals.activeLink === "examples") { %>header__navigation-link--active<% } %>">Examples</a></li>
                     <li><a href="<%= pathToRootFolder %>documentation/getting-started/" class="header__navigation-link <% if (locals.activeLink === "documentation") { %>header__navigation-link--active<% } %>">Documentation</a></li>
                     <li>
-                        <a href="#" target="_blank" class="header__navigation-icon-link">
+                        <a href="https://www.npmjs.com/package/@jirkasa/code-box" target="_blank" class="header__navigation-icon-link">
                             <svg>
                                 <use xlink:href="<%= pathToRootFolder %>static/icon-sprite.svg#npm"></use>
                             </svg>

diff --git a/pages/index.ejs b/pages/index.ejs
@@ -6,7 +6,7 @@
             <p class="home-page-intro-section__intro-text">JavaScript library for displaying code samples on the web.</p>
             <div class="home-page-intro-section__call-to-actions">
                 <a href="./documentation/getting-started/" class="home-page-intro-section__get-started-button">Get Started</a>
-                <div class="home-page-intro-section__installation-command">npm install code-box</div>
+                <div class="home-page-intro-section__installation-command">npm install @jirkasa/code-box</div>
             </div>
         </div>
     </div>
@@ -35,11 +35,4 @@
     <footer class="footer">
         <div class="footer__content footer__content--centered">Created by <a href="https://jirkasa.github.io/" target="_blank" class="footer__link">Jiří Satora</a></div>
     </footer>
-<%- include("./includes/page-end.ejs") %>
-
-
-
-
-<!--
-    todo - nezapomenout na todo - zkusit naimportovat CSS core styles
--->
+<%- include("./includes/page-end.ejs") %>