Merge pull request #1 from AnilChinchawale/main

Revamp XDC Network Docs 2.0

.github/workflows/deploy-mkdocs.yml

@@ -0,0 +1,40 @@
+name: Deploy MkDocs site to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material
+          pip install mkdocs-video
+          pip install mkdocs-redirects
+
+      - name: Build MkDocs site
+        run: mkdocs build
+
+      - name: Deploy to GitHub Pages
+        if: github.event_name == 'push'
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          cname: docs.xdc.network
+          allow_empty_commit: true

CNAME

@@ -0,0 +1 @@
+docs.xdc.network

README.md

@@ -1 +1,29 @@
-# Docs
+# Welcome to XDC Network Knowledge Base
+
+This is the XDC Network Knowledge Base documentation for the XDC Network developers. It is based on the Mkdocs Material theme. 
+
+## Run locally
+
+### Prerequisites
+
+1. [Python 3.12](https://www.python.org/downloads/).
+2. [`virtualenv`](https://pypi.org/project/virtualenv/): Install using `pip3 install virtualenv`.
+
+### Setup
+
+1. Clone the repository.
+2. `cd` to the root.
+3. Run the `run.sh` script. You may need to make the script executable: `chmod +x run.sh`
+
+```sh
+./run.sh
+```
+
+The site comes up at http://127.0.0.1:8000/ 
+
+
+
+## 📜 License
+
+Copyright (c) 2024 XDC Network 
+

docs/CNAME

@@ -0,0 +1 @@
+docs.xdc.network

docs/announce/index.md

@@ -0,0 +1,26 @@
+
+# Announcement
+
+<div class="doc-announce">
+    <a href="https://www.xdc.dev/anilchinchawale/xdpos-20-mainnet-release-key-features-and-enhancements-eeo">
+        <div>
+            <div class="announce-title">XDC 2.0 Mainnet Release </div>
+            <div class="announce-desc">XDC 2.0 Mainnet Release: Key Features and Enhancements</div>
+        </div>
+        <span class="announce-date">October 2, 2024</span>
+    </a>
+    <a href="./#">
+        <div>
+            <div class="announce-title">XinFin Remix Upgrade </div>
+            <div class="announce-desc">XinFin Remix is getting a major upgrade and will be launching soon.</div>
+        </div>
+        <span class="announce-date">Coming Soon!</span>
+    </a>
+    <a href="https://www.xdc.dev/anilchinchawale/stay-ahead-xdc-network-prepares-for-evm-0823-integration-on-xdc-mainnet-upgrade-details-inside-5nj">
+        <div>
+            <div class="announce-title">Solidity 0.8.23 Integration on XDC Mainnet </div>
+            <div class="announce-desc">This EVM upgrade supports the latest version of the Solidity smart contract programming language, version 0.8.23.</div>
+        </div>
+        <span class="announce-date">2024 June</span>
+    </a>
+</div>

docs/assets/js/custom.js

@@ -0,0 +1,9 @@
+document.addEventListener("DOMContentLoaded", function() {
+    var navLinks = document.querySelectorAll("nav a");
+
+    navLinks.forEach(function(link) {
+        if (link.href.startsWith("http") && !link.href.includes(window.location.hostname)) {
+            link.setAttribute("target", "_blank");
+        }
+    });
+});

docs/assets/js/mathjax.js

@@ -0,0 +1,16 @@
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};
+
+document$.subscribe(() => {
+  MathJax.typesetPromise()
+})

docs/assets/style/components/banner.css

@@ -0,0 +1,22 @@
+.md-banner {
+    background-color: var(--doc-support-warning-1);
+    text-align: center;
+    color: var(--doc-text-on-color);
+}
+
+.md-banner a {
+    color: var(--doc-text-on-color);
+    font-weight: 700;
+    text-decoration: underline;
+}
+
+.md-banner a:focus,
+.md-banner a:hover {
+    color: var(--doc-text-brand);
+}
+
+.md-banner__inner {
+    font-size: 14px;
+    line-height: 20px;
+    margin: 10px auto;
+}