Add website (#11)

Signed-off-by: Xavier Lau <[email protected]>

.github/replace.py

@@ -0,0 +1,27 @@
+import os
+import re
+
+
+def replace_pattern_in_file(file_path, pattern, replacement):
+    with open(file_path, "r+") as file:
+        file_contents = file.read()
+        updated_contents = re.sub(pattern, replacement, file_contents)
+
+        file.seek(0)
+        file.write(updated_contents)
+
+
+for root, dirs, files in os.walk(
+    os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), "DIPs")
+):
+    for filename in files:
+        if filename.endswith(".md"):
+            file_path = os.path.join(root, filename)
+
+            replace_pattern_in_file(
+                file_path,
+                r"\.\./LICENSE",
+                "https://github.com/darwinia-network/DIPs/blob/main/LICENSE",
+            )
+
+print("Replacement complete.")

.github/workflows/pages.yml

@@ -0,0 +1,49 @@
+name: Deploy Pages
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          cache: 'poetry'
+      - name: Build
+        run: |
+          python3 .github/replace.py
+          cd website
+          pip3 install poetry
+          poetry shell
+          make html
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: "website/_build"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v3

.gitignore

@@ -4,3 +4,6 @@
 # Integrated Development Environment
 .idea
 .vscode
+
+# Cache
+_build

DIPs/dip-0.md

@@ -10,6 +10,7 @@ created: 2023-11-28
 ---
 
 
+# DIP-0
 ## Abstract
 This DIP explicates the staking power specification applicable to Darwinia and Crab.
 
@@ -60,4 +61,4 @@ assert_eq!(power_of(S2), 75 / 100 * HALF_POWER + 25 / 50 * HALF_POWER);
 
 
 ## Copyright
-Copyright and related rights waived via [CC0](../LICENSE).
+Copyright and related rights waived via [CC0](https://github.com/darwinia-network/DIPs/blob/main/LICENSE).

DIPs/dip-1.md

@@ -10,6 +10,7 @@ created: 2023-11-27
 ---
 
 
+# DIP-1
 ## Abstract
 This DIP outlines the staking commission specification applicable on Darwinia and Crab.
 
@@ -63,4 +64,4 @@ let abr = remain * aa_of_pa; // , which is `45 * 90 / 135 = 30`.
 
 
 ## Copyright
-Copyright and related rights waived via [CC0](../LICENSE).
+Copyright and related rights waived via [CC0](https://github.com/darwinia-network/DIPs/blob/main/LICENSE).

DIPs/dip-2.md

@@ -9,6 +9,7 @@ created: 2023-12-13
 ---
 
 
+# DIP-2
 ## Abstract
 To facilitate Ethereum integration, Substrate-based chains are transitioning to `H160` account addresses, using `ECDSA` for signatures.
 This change streamlines the user experience by consolidating address types and wallets.
@@ -47,4 +48,4 @@ All pallet addresses have been truncated to 20 bytes; simply remove the trailing
 
 
 ## Copyright
-Copyright and related rights waived via [CC0](../LICENSE).
+Copyright and related rights waived via [CC0](https://github.com/darwinia-network/DIPs/blob/main/LICENSE).

website/DIPs

@@ -0,0 +1 @@
+../DIPs

website/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

website/conf.py

@@ -0,0 +1,17 @@
+project = 'dips'
+copyright = '2023, Darwinia Network'
+author = 'Darwinia Network'
+
+extensions = ['myst_parser']
+
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+html_title = 'Darwinia Improvement Proposals'
+html_logo = '../logo.svg'
+html_theme = 'furo'
+html_static_path = ['_static']
+html_theme_options = {
+    'navigation_with_keys': True,
+    'sidebar_hide_name': True,
+}
+

website/index.rst

@@ -0,0 +1,9 @@
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+
+
+.. toctree::
+   :glob:
+   :hidden:
+
+   DIPs/*