diff --git a/.github/workflows/deploy-mkdocs.yml b/.github/workflows/deploy-mkdocs.yml new file mode 100644 index 0000000..aa29cad --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/CNAME b/CNAME new file mode 100644 index 0000000..75920a6 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +docs.xdc.network diff --git a/README.md b/README.md index cc33018..03c99ae 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -# Docs \ No newline at end of file +# 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 + diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..ff1fd62 --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +docs.xdc.network \ No newline at end of file diff --git a/docs/announce/index.md b/docs/announce/index.md new file mode 100644 index 0000000..73f30b5 --- /dev/null +++ b/docs/announce/index.md @@ -0,0 +1,26 @@ + +# Announcement + +
Get started with XDC Network: Unlock the power of decentralized finance and global trade.
+ + +Stay updated with the latest XDC Network announcements and developments.
+ + +Obtain the RPC Endpoint for XDC Network
+ + +XDC Network Masternodes are the backbone of the network, ensuring lightning-fast transaction validation and enhanced security.
+ + +The XDC Chain Network provides a variety of tools and resources to help developers build and deploy applications on the blockchain.
+ + +XDC Subnet is a technology that allows you to create a secure, scalable, and decentralized network within the XDC Ecosystem.
+ +Discover top dApps built on XDC Network Chain, the leading blockchain scaling solution.
+ + +RWA on XDC Network!
+ + +DeFi on XDC Network!
+ +The XDC Network is a cutting-edge blockchain platform designed to revolutionize the way businesses manage and exchange data, assets, and financial records. Boasting impressive speed and scalability, the XDC Network is capable of handling a high volume of transactions with minimal delays, making it ideal for enterprise-level applications. Its low transaction fees further enhance its appeal, allowing businesses to conduct operations cost-effectively.
+ +What truly sets the XDC Network apart is its military-grade security, ensuring that all data exchanges and asset transfers are protected against potential threats. This level of security is crucial for industries where trust and confidentiality are paramount. By leveraging the XDC Network, businesses can streamline their operations, improve record-keeping accuracy, and facilitate more efficient and secure data exchanges. Whether it's in finance, supply chain management, or trade, the XDC Network provides a robust and reliable infrastructure that empowers businesses to thrive in the digital age.
+User guide to get started on XDC Chain
+ + + +XDC Network is a community-oriented ecosystem, meticulously built upon the foundation of decentralized governance.
+ + + + +XDC ecosystem and developer tools
+ + +How to run a XDC Masternode
+ + +Interacting with XDC requires sending requests to specific JSON-RPC API methods.
+ +