Merge pull request #947 from multiversx/rm/structure-updates

Structure Updates
multiversx · Jul 30, 2024 · 7111a2d · 7111a2d
2 parents b887b94 + 50804cb
commit 7111a2d
Show file tree

Hide file tree

Showing 19 changed files with 2,772 additions and 181 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
-# MultiversX docs
+# MultiversX Docs
 
 The repository contains the [documentation](https://docs.multiversx.com) for the MultiversX Network protocol.
 
+![docs.multiversx.com](https://github.com/multiversx/mx-docs/blob/main/static/img/share.jpg)
+
 ## About
 
 The documentation is built over a custom [docusaurus](https://docusaurus.io/) solution and relies on Markdown files.
@@ -11,13 +13,13 @@ This repository also has GitHub actions that will trigger the real-time updating
 
 In order to ensure that the newly added content is correctly aligned and every Markdown feature is working as intended, one can run the project on a local machine.
 
-### Requirements:
+### Requirements
 
 - a `git` client installed
-- `nodejs` (v16.14.2) and `npm` installed
+- `nodejs` (v18.19.0 LTS) and `npm` installed
 - optional, but useful: an IDE (Visual Code for example)
 
-### Steps:
+### Steps
 
 - clone the repository
 - run `npm install` (only for the first usage)
@@ -44,7 +46,7 @@ Anyone can contribute to the docs. Any help is appreciated. Here are some ways i
 
 ### Guidelines
 
-Each documentation page should include a `Edit this page` link that will redirect the user to the corresponding GitHub edit page. 
+Each documentation page should include a `Edit this page` link that will redirect the user to the corresponding GitHub edit page.
 
 Alternatively, contributions can be made manually by following the steps below:
 

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -96,6 +96,17 @@ const config = {
 
       // Replace with your project's social card
       image: "img/share.jpg",
+
+      metadata: [
+        { name: "twitter:site", content: "@MultiversX" },
+        { name: "twitter:creator", content: "@MultiversX" },
+        { name: "twitter:title", content: "MultiversX Docs" },
+        {
+          name: "twitter:description",
+          content:
+            "A highly scalable, fast and secure blockchain platform for distributed apps, enterprise use cases and the new internet economy.",
+        },
+      ],
       navbar: {
         logo: {
           alt: "MultiversX Docs",
@@ -193,7 +204,16 @@ const config = {
       prism: {
         theme: prismThemes.vsLight,
         darkTheme: prismThemes.vsDark,
-        additionalLanguages: ["rust", "tsx", "toml", "bash", "diff", "json", "solidity", "yaml"],
+        additionalLanguages: [
+          "rust",
+          "tsx",
+          "toml",
+          "bash",
+          "diff",
+          "json",
+          "solidity",
+          "yaml",
+        ],
       },
       algolia: {
         // The application ID provided by Algolia
@@ -492,7 +512,68 @@ const config = {
         },
       },
     ],
-    async function myPlugin(context, options) {
+    [
+      "pwa",
+      {
+        // debug: isDeployPreview,
+        offlineModeActivationStrategies: [
+          "appInstalled",
+          "standalone",
+          "queryString",
+        ],
+        // swRegister: false,
+        // swCustom: require.resolve("./src/sw.js"), // TODO make it possible to use relative path
+        pwaHead: [
+          {
+            tagName: "link",
+            rel: "icon",
+            href: "img/favicons/apple-touch-icon.png",
+          },
+          {
+            tagName: "link",
+            rel: "manifest",
+            href: "manifest/manifest.json",
+          },
+          {
+            tagName: "meta",
+            name: "theme-color",
+            content: "rgb(14, 14, 14)",
+          },
+          {
+            tagName: "meta",
+            name: "apple-mobile-web-app-capable",
+            content: "yes",
+          },
+          {
+            tagName: "meta",
+            name: "apple-mobile-web-app-status-bar-style",
+            content: "#0e0e0e",
+          },
+          {
+            tagName: "link",
+            rel: "apple-touch-icon",
+            href: "img/favicons/apple-touch-icon.png",
+          },
+          {
+            tagName: "link",
+            rel: "mask-icon",
+            href: "img/favicons/apple-touch-icon.png",
+            color: "rgb(14, 14, 14)",
+          },
+          {
+            tagName: "meta",
+            name: "msapplication-TileImage",
+            content: "img/favicons/mstile-150x150.png",
+          },
+          {
+            tagName: "meta",
+            name: "msapplication-TileColor",
+            content: "#0e0e0e",
+          },
+        ],
+      },
+    ],
+    async function tailwindPlugin(context, options) {
       return {
         name: "docusaurus-tailwindcss",
         configurePostCss(postcssOptions) {