Add docusaurus

Author: Dr-Electron

.github/workflows/test-docs-build.yml

@@ -0,0 +1,24 @@
+name: Test Docs Build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+concurrency: 
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Test Build
+        run: |
+          corepack enable
+          yarn install --no-immutable
+          yarn build

.gitignore

@@ -1,2 +1,34 @@
 book/
 src/
+
+# Dependencies
+node_modules
+
+# Yarn
+yarn.lock
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+package-lock.json
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

CONTRIBUTE.md

@@ -0,0 +1,28 @@
+> **Note**
+> This guide is meant for local development and contributing to the repository only, for guidance on the TIPs process and how to propose Tangle improvements, please see the [README](README.md)
+
+
+# Documentation
+
+The TIPs online documentation is built using [Docusaurus 2](https://docusaurus.io/). The deployment is done through a centralized build from [IOTA WIKI](https://github.com/iota-wiki/iota-wiki). To run a local instance, the [IOTA WIKI CLI](https://www.npmjs.com/package/@iota-wiki/cli) is used.
+
+## Prerequisites
+
+- [Node.js 16.10 or above](https://nodejs.org/en/download/).
+- [Modern Yarn](https://yarnpkg.com/getting-started/install) enabled by running `corepack enable`.
+
+## Installation
+
+```console
+yarn
+```
+
+This command installs all necessary dependencies.
+
+## Local Development
+
+```console
+yarn start
+```
+
+This command starts a local, wiki themed development server and opens up a browser window. Most changes are reflected live without having to restart the server.

README.md

@@ -8,7 +8,7 @@ Building the IOTA ecosystem is a community effort, therefore we welcome anyone t
 
 Do you have an idea how to improve the IOTA technology stack?
 - Head over to the [discussions](https://github.com/iotaledger/tips/discussions) page to browse already submitted ideas or share yours!
-- Once your idea is discussed, you can submit a draft TIP ([template here](./tip-template.md)) as a PR to the repository.
+- Once your idea is discussed, you can submit a draft TIP ([template here](https://github.com/iotaledger/tips/blob/main/tip-template.md) as a PR to the repository.
 - You will receive feedback from the TIP Editors and review from core devs.
 - Once accepted, your TIP is merged as Draft.
 - It is your responsibility to drive its implementation and to present a clear plan on how the new feature will be adopted by the network.

docusaurus.config.js

@@ -0,0 +1,39 @@
+const { link } = require('fs');
+const path = require('path');
+
+module.exports = {
+  plugins: [
+    [
+        '@docusaurus/plugin-content-docs',
+        {
+            id: 'iota-tips', 
+            path: path.resolve(__dirname, './'),
+            routeBasePath: 'tips',
+            editUrl: 'https://github.com/iotaledger/tips/edit/main/',
+            remarkPlugins: [require('remark-import-partial')],
+            include: ['tips/**/*.md', 'README.md'],
+
+            // Create own sidebar to flatten hierarchy and use own labeling
+            async sidebarItemsGenerator({
+              defaultSidebarItemsGenerator,
+              ...args
+            }) {
+              const items = await defaultSidebarItemsGenerator(args);
+
+              const result = items[1].items.map((item) => {
+                if (item.type === 'category') {
+                  if (item.link.type === 'doc') {
+                    // Get TIP number and append TIP name
+                    item.label = item.link.id.slice(-4) + '-' + item.label
+                  }
+                }
+                return item;
+              });
+
+              return [items[0]].concat(result);
+            },
+        }
+    ],
+  ],
+  staticDirectories: [],
+};

package.json

@@ -0,0 +1,16 @@
+{
+    "name": "iota-tips",
+    "version": "0.0.0",
+    "scripts": {
+        "start": "iota-wiki start",
+        "build": "iota-wiki build"
+    },
+    "license": "UNLICENSED",
+    "engines": {
+        "node": ">=16.10.0"
+    },
+    "devDependencies": {
+        "@iota-wiki/cli": "latest"
+    },
+    "packageManager": "[email protected]"
+}

tips/TIP-0001/tip-0001.md

@@ -56,7 +56,7 @@ TIPs must adhere to the format and structure requirements that are outlined in t
 
 ### TIP Template
 
-The template to follow for new TIPs is located in the [repository](../../tip-template.md).
+The template to follow for new TIPs is located in the [repository](https://github.com/iotaledger/tips/blob/main/tip-template.md).
 
 ### TIP Process
 

tips/TIP-0004/tip-0004.md

@@ -59,13 +59,13 @@ In the following we define the Merkle tree hash (MTH) function that returns the
 - The output is a single 32-byte hash.
 
 Given an ordered list of n input strings D<sub>n</sub> = {d<sub>1</sub>, d<sub>2</sub>, ..., d<sub>n</sub>}, the Merkle tree hash of D is defined as follows:
-- If D is an empty list, MTH(D) is the hash of an empty string:<br>
+- If D is an empty list, MTH(D) is the hash of an empty string:<br/>
   MTH({}) = BLAKE2().
-- If D has the length 1, the hash (also known as a leaf hash) is:<br>
+- If D has the length 1, the hash (also known as a leaf hash) is:<br/>
   MTH({d<sub>1</sub>}) = BLAKE2( 0x00 || d<sub>1</sub> ).
 - Otherwise, for D<sub>n</sub> with n > 1:
   - Let k be the largest power of two less than n, i.e. k < n ≤ 2k.
-  - The Merkle tree hash can be defined recursively:<br>
+  - The Merkle tree hash can be defined recursively:<br/>
     MTH(D<sub>n</sub>) = BLAKE2( 0x01 || MTH({d<sub>1</sub>, ..., d<sub>k</sub>}) || MTH({d<sub>k+1</sub>, ..., d<sub>n</sub>}) ).
 
 Note that the hash calculations for leaves and nodes differ. This is required to provide second preimage resistance: Without such a prefix, for a given input D an attacker could replace  two (or more) leaves with their corresponding aggregated node hash without changing the final value of MTH(D). This violates the fundamental assumption that, given MTH(D), it should be practically impossible to find a different input D' leading to the same value. Adding a simple prefix mitigates this issue, since now leaf and node hashes are computed differently and can no longer be interchanged.

tips/TIP-0006/tip-0006.md

@@ -111,6 +111,8 @@ The following table describes the serialization of a _Message_ following the not
           </tr>
         </table>
       </details>
+    </td>
+  </tr>
   <tr>
     <td>Nonce</td>
     <td>uint64</td>