Initial commit

https://github.com/codex-storage/infra-codex/issues/59

.gitignore

@@ -0,0 +1,10 @@
+node_modules
+.vitepress/dist
+.vitepress/cache
+*.log
+*.tgz
+.DS_Store
+.idea
+.temp
+.vite_opt_cache
+.vscode

.vitepress/config.mts

@@ -0,0 +1,100 @@
+import { defineConfig } from 'vitepress'
+
+// const { BASE: base = '/' } = process.env;
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  lang: 'en-US',
+  title: 'Codex Docs',
+  description: 'Decentralised data storage platform',
+  lastUpdated: true,
+  cleanUrls: true,
+  ignoreDeadLinks: false,
+  appearance: true,
+//  base: base,
+
+  // lite-youtube-embed
+  vue: {
+    template: {
+      compilerOptions: {
+        isCustomElement: (tag) => tag === 'lite-youtube',
+      },
+    },
+  },
+
+  head: [
+    [
+      'link', { rel: 'icon', href: '/favicons/favicon.svg', type: 'image/svg+xml' }
+    ]
+  ],
+
+  srcExclude: ['README.md'],
+
+  outDir: './.vitepress/dist',
+  assetsDir: 'assets',
+
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Whitepaper', link: '/learn/whitepaper' }
+    ],
+
+    search: {
+      provider: 'local',
+      options: {
+        detailedView: true,
+      },
+    },
+
+    editLink: {
+      pattern: 'https://github.com/codex-storage/codex-docs/edit/master/:path',
+      text: 'Edit this page on GitHub',
+    },
+
+    logo: {
+      alt: 'Codex • Docs',
+      light: '/codex-mark-primary-black-resized.png',
+      dark: '/codex-mark-primary-white-resized.png',
+    },
+
+    siteTitle: 'Codex • Docs',
+
+    sidebar: [
+      {
+        text: 'Introduction',
+        collapsed: false,
+        items: [
+          { text: 'What is Codex?', link: '/learn/what-is-codex' },
+          { text: 'Quick start', link: '/learn/quick-start' },
+          { text: 'Architecture', link: '/learn/architecture' },
+          { text: 'Marketplace', link: '/learn/marketplace' },
+          { text: 'Whitepaper', link: '/learn/whitepaper' },
+          { text: 'Build Codex', link: '/learn/build' },
+          { text: 'Run Codex', link: '/learn/run' },
+          { text: 'Deploy Codex', link: '/learn/deploy' }
+        ]
+      },
+      {
+        text: 'Codex networks',
+        collapsed: false,
+        items: [
+          { text: 'Testnet', link: '/networks/testnet' }
+        ]
+      },
+      {
+        text: 'Developers',
+        collapsed: false,
+        items: [
+          { text: 'API', link: '/developers/api' }
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/codex-storage/codex-docs' },
+      { icon: 'twitter', link: 'https://twitter.com/Codex_storage' },
+      { icon: 'youtube', link: 'https://www.youtube.com/@CodexStorage' },
+      { icon: 'discord', link: 'https://discord.gg/codex-storage' }
+    ]
+  }
+})

.vitepress/theme/Layout.vue

@@ -0,0 +1,22 @@
+<!-- https://vitepress.dev/guide/extending-default-theme#layout-slots -->
+<script setup>
+import DefaultTheme from 'vitepress/theme'
+</script>
+
+<template>
+  <DefaultTheme.Layout>
+    <template #home-hero-image>
+      <div>
+        <iframe
+          width="520"
+          height="315"
+          src="https://www.youtube.com/embed/NZEOilcLdKA?si=WrnLR1Mm71FkgFvC?controls=0"
+          title="Codex @ depin:con - Codex: Data Durability Engine & DSN (Presentation)"
+          frameborder="0"
+          allow="encrypted-media"
+          allowfullscreen>
+        </iframe>
+      </div>
+    </template>
+  </DefaultTheme.Layout>
+</template>

.vitepress/theme/custom.css

@@ -0,0 +1,4 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */

.vitepress/theme/index.ts

@@ -0,0 +1,9 @@
+// https://vitepress.dev/guide/extending-default-theme#layout-slots
+import DefaultTheme from 'vitepress/theme'
+import Layout from './Layout.vue'
+import './custom.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: Layout,
+}

LICENSE-APACHE-2.0

@@ -0,0 +1,199 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

LICENSE-MIT

@@ -0,0 +1,19 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,73 @@
+# Codex documentation
+
+ Welcome to Codex documentation.
+
+ Codex is a decentralised data storage platform that provides exceptionally strong censorship resistance and durability guarantees.
+
+
+## Run and build
+
+ For documentation we use [VitePress](https://vitepress.dev/), which is [Vue](https://vuejs.org/)-powered static site generator built on top of [Vite](https://vitejs.dev/).
+
+ To run site locally, we should clone repository and run the following command
+ ```shell
+ npm run docs:dev
+ ```
+
+ <details>
+ <summary>Detailed guide</summary>
+
+ 1. [Install](https://nodejs.org/en/download/package-manager) node 20 or [above](https://nodejs.org/en/about/previous-releases)
+
+    Using [nvm](https://github.com/nvm-sh/nvm)
+    ```shell
+    # nvm
+    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
+
+    # Node 22
+    nvm install 22
+    nvm use 22
+
+    # Check
+    node --version
+    v22.6.0
+    ```
+
+ 2. Clone repository
+    ```shell
+    git clone https://github.com/codex-storage/codex-docs
+    cd codex-docs
+    ```
+
+ 3. Start a local dev server with instant hot updates
+    ```shell
+    # Local
+    npm run docs:dev
+
+    # Expose
+    npm run docs:dev -- --host
+    ```
+
+ 4. [Build the site](https://vitepress.dev/guide/deploy)
+    ```shell
+    npm run docs:build
+
+    # .vitepress/dist
+    ```
+ </details>
+
+
+## Contribute
+
+ Please check [VitePress documentation](https://vitepress.dev/) for more details about customizations.
+
+ Process
+ - Create a fork
+ - Create a custom branch in your fork
+ - Add your contribution
+ - Make a PR to the upstream repository
+
+ Project structure
+ - `learn` - All information to learn about Codex
+ - `networks` - Codex networks related information
+ - `developers` - Codex development process and guides

developers/api.md

@@ -0,0 +1,5 @@
+# Codex API
+
+ Work in progress :construction:
+
+ Please read [api.codex.storage](https://api.codex.storage/) for now.

index.md

@@ -0,0 +1,33 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: Codex
+  text: Decentralised data storage platform
+  tagline: Codex is a durable, decentralised data storage protocol, created so the world community can preserve its most important knowledge without risk of censorship.
+  actions:
+    - theme: brand
+      text: What is Codex?
+      link: /learn/what-is-codex
+    - theme: alt
+      text: Quick start
+      link: /learn/quick-start
+    - theme: alt
+      text: Join Codex Testnet
+      link: /networks/testnet
+
+features:
+  - title: Learn
+    details: Get more information about Codex
+    link: /learn/what-is-codex
+    icon: 📚
+  - title: Networks
+    details: Participate in Codex network as a Storage operator or Buyer
+    link: /networks
+    icon: 🚦
+  - title: Developers
+    details: Build and Codex and
+    link: /developers/api
+    icon: 🏗️
+---

learn/architecture.md

@@ -0,0 +1,57 @@
+# Description and architecture
+
+Codex is building a durable data storage engine that is fully decentralised, providing corruption and censorship resistance to web3 applications. It innately protects network participants by giving hosts plausible deniability over the data they store, and clients provable durability guarantees—up to 99.99%—while remaining storage and bandwidth efficient.
+
+These four key features combine to differentiate Codex from existing projects in the decentralised storage niche:
+
+- **Erasure coding:** Provides efficient data redundancy, which increases data durability guarantees.
+
+- **ZK-based proof-of-retrievability:** For lightweight data durability assurances.
+
+- **Lazy repair mechanism:** For efficient data reconstruction and loss prevention.
+
+- **Incentivization:**  To encourage rational behaviour, widespread network participation, and the efficient provision of finite network resources.
+
+
+### Incentivized decentralisation
+
+Incentivization mechanisms are one of the key pieces missing from traditional file-sharing networks. Codex believes that a robust marketplace-based incentive structure will ensure wide participation across the node types detailed below.
+
+The development of an adequate incentive structure is driven by the following goals: 
+
+- Supply and demand to encourage optimum network resource usage.
+
+- Increase participation by enabling nodes to utilise their competitive advantages to maximise profits.
+
+- Prevent spam and discourage malicious participation. 
+
+Although still to be finalised, the Codex incentive structure will involve a marketplace of participants who want to store data, and those provisioning storage posting collateral, with the latter bidding on open storage contracts. This structure aims to ensure that participants' incentives align, resulting in Codex functioning as intended.
+
+
+### Network architecture
+
+Codex is composed of multiple node types, each taking a different role in the network's operation. Similarly, the hardware demands for each node type vary, enabling those operating resource-restricted devices to participate.
+
+**Storage nodes**
+
+As Codex's long-term reliable storage providers, storage nodes stake collateral based on the collateral posted on the request side of contracts, and the number of slots that a contract has. This is tied to the durability demanded by the user. Failure to provide periodic proof of data possession results in slashing penalties.
+
+**Aggregator Node**
+
+A method for off-loading erasure coding, proof generation and proof aggregation by a client node with low-resources, currently a WIP and will be part of subsequent Codex release Q2/Q4 next year.
+
+**Client nodes**
+
+Client nodes make requests for other nodes to store, find, and retrieve data. Most of the Codex network will be Client nodes, and these participants can double as caching nodes to offset the cost of the network resources they consume. 
+
+When a node commits to a storage contract and a user uploads data, the network will proactively verify that the storage node is online and that the data is retrievable. Storage nodes are then randomly queried to broadcast proofs of data possession over an interval corresponding to the contract duration and 9's of retrievability guarantee the protocol provides.
+
+If the storage node sends invalid proofs or fails to provide them in time, the network evicts the storage node from the slot, and the slot will become available for the first node that generates a valid proof for that slot. 
+
+When the contract is reposted, some of the faulty node's collateral pays for the new storage node's bandwidth fees. Erasure coding complements the repair scheme by allowing the reconstruction of the missing chunks from data in other slots within the same storage contract hosted by faultless storage nodes.
+
+
+![architect](/learn/architecture.png)
+
+
+Read the [Codex whitepaper](/learn/whitepaper)

learn/build.md

@@ -0,0 +1,5 @@
+# Build Codex
+
+ Work in progress :construction:
+
+ Please read [Building Codex](https://github.com/codex-storage/nim-codex/blob/master/BUILDING.md).

learn/deploy.md

@@ -0,0 +1,3 @@
+# Deploy Codex
+
+ Work in progress :construction:

learn/marketplace.md

@@ -0,0 +1,3 @@
+# Marketplace
+
+ Work in progress :construction:

learn/quick-start.md

@@ -0,0 +1,7 @@
+# Quick start
+
+ Work in progress :construction:
+
+ Please read
+ - [Codex Two-Client Test](https://github.com/codex-storage/nim-codex/blob/master/docs/TwoClientTest.md)
+ - [Running a Local Codex Network with Marketplace Support](https://github.com/codex-storage/nim-codex/blob/master/docs/Marketplace.md)

learn/run.md

@@ -0,0 +1,3 @@
+# Run Codex
+
+ Work in progress :construction:

learn/what-is-codex.md

@@ -0,0 +1,36 @@
+# What is Codex?
+
+Work in progress :construction:
+
+Codex is a decentralised data storage platform that provides exceptionally strong censorship resistance and durability guarantees. It serves as the storage layer of the [Logos](https://logos.co/) tech stack. Alongside the trustless agreement layer, [Nomos](http://nomos.tech), and the communications layer, [Waku](http://waku.org), it is one of the Logos Collective's foundational projects.
+
+<br/>
+
+### Motive
+
+The remote storage landscape is dominated by an increasingly small number of internet powerhouses—Google, Microsoft, Amazon, etc. While these services score highly in terms of user experience and convenience, centralised cloud data storage suffers from the following drawbacks:
+
+- Censorship
+
+- Lack of data ownership
+
+- Breaches and outages
+
+- High cost
+
+Centralised cloud storage providers have an established history of censoring data and, as de facto owners of said data, have the power to do so according to their own standards. Furthermore, centralised platforms have fallen victim to major data breaches and service outages on numerous occasions.
+
+Such incidents have created a gap in the market for a decentralised, censorship-resistant alternative. Existing peer-to-peer storage and file-sharing networks address some of these issues—such as robustness in the face of network disruptions, and desirable resistance to censorship. Yet without adequate incentives and strong data durability guarantees, they make for unsuitable foundations upon which to build truly unstoppable applications.
+
+Existing decentralised storage solutions purport to improve upon early P2P file-sharing platforms like eDonkey and Gnutella. However, the market still lacks a decentralised storage solution that is efficient in terms of storage and bandwidth usage, while offering performance and durability guarantees comparable to incumbents. 
+
+<br/>
+
+### Decentralising data storage
+
+Codex began in 2021 to address a need for a durable, decentralised storage layer for the web3 tech stack.
+
+The name "Codex" refers to an ancient form of book—an allusion to the data storage engine's extremely robust—99.99%—durability guarantees.
+
+Codex was announced as a core Logos Collective protocol in June 2023.
+

learn/whitepaper.md

@@ -0,0 +1,3 @@
+# Codex whitepaper
+
+ Work in progress :construction:

networks/index.md

@@ -0,0 +1,5 @@
+# Codex networks
+
+ Work in progress :construction:
+
+ Codex networks overview

networks/testnet.md

@@ -0,0 +1,5 @@
+# Codex Testnet
+
+ Work in progress :construction:
+
+ Please follow [Codex Testnet Starter](https://testnet.codex.storage).

package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "lite-youtube-embed": "^0.3.3",
+    "vitepress": "^1.3.2"
+  },
+  "scripts": {
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview"
+  }
+}

public/favicons/favicon.svg

@@ -0,0 +1,13 @@
+<svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <style>
+    path {
+    fill: #000;
+    }
+    @media (prefers-color-scheme: dark) {
+    path {
+    fill: #fff;
+    }
+    }
+  </style>
+  <path fill-rule="evenodd" clip-rule="evenodd" d="M23.5847 46.8895C23.7112 46.9624 23.8544 47 23.9989 47C24.1436 47 24.4615 46.8606 24.4615 46.8606L43.6208 35.8244C43.6307 35.8196 43.6445 35.8126 43.6578 35.8049C43.7861 35.7319 43.8907 35.6262 43.9633 35.5006C44.0375 35.3738 44.0765 35.2296 44.0765 35.0832C44.0765 35.0658 44.0758 35.0498 44.0751 35.0377V12.9646C44.0765 12.9446 44.0765 12.9269 44.0765 12.9179V12.9155C44.0765 12.7687 44.0373 12.6255 43.9646 12.4995C43.8918 12.3725 43.7863 12.2675 43.6603 12.1948C43.6467 12.1867 43.6323 12.179 43.6179 12.1719L24.4593 1.13666C24.4453 1.12717 24.4316 1.11889 24.4201 1.11209C24.2931 1.03844 24.1481 1 24.0023 1H23.9989C23.8532 1 23.7103 1.03853 23.5863 1.10929C23.5702 1.11828 23.5552 1.12769 23.5418 1.13679L4.37855 12.1748C4.36869 12.1797 4.35487 12.1869 4.34153 12.1944C4.21404 12.2674 4.10845 12.3739 4.03567 12.4999C3.96278 12.6259 3.92347 12.7691 3.92347 12.9161C3.92347 12.9337 3.92418 12.9495 3.92485 12.9615V35.0354C3.92341 35.0553 3.92345 35.0731 3.92347 35.0821V35.0844C3.92347 35.2311 3.96262 35.3756 4.03693 35.5024C4.10961 35.6271 4.21432 35.7321 4.33731 35.8034L4.33979 35.8049L4.34231 35.8061C4.35733 35.8144 4.37095 35.8214 4.3813 35.8266L23.5428 46.8634C23.5518 46.8695 23.5676 46.8798 23.5847 46.8895ZM43.5351 35.5896C43.5254 35.595 43.5144 35.6005 43.5035 35.6059C43.5094 35.6031 43.5157 35.6 43.5212 35.5969C43.5261 35.5946 43.5308 35.5921 43.5351 35.5896ZM43.8273 35.0449C43.8276 35.049 43.8278 35.0535 43.828 35.058C43.8283 35.0659 43.8287 35.0744 43.8287 35.0832C43.8287 35.0805 43.8287 35.0778 43.8285 35.0751C43.8283 35.0643 43.8278 35.0541 43.8273 35.0449ZM24.8394 36.5362L31.957 40.6294L24.8336 44.732L24.8394 36.5362ZM16.0434 40.6292L23.1613 36.5359L23.1669 44.732L16.0434 40.6292ZM34.4613 30.9931L41.5789 35.0861L34.4557 39.1887L34.4613 30.9931ZM24.8395 33.6354V25.4512L31.943 29.5433L24.8395 33.6354ZM15.2176 28.0928V19.9086L22.3211 24.0007L15.2176 28.0928ZM24.8395 22.5488V14.3646L31.943 18.4567L24.8395 22.5488ZM23.1621 11.4641L16.0441 7.3708L23.1676 3.26794L23.1621 11.4641ZM6.42182 35.0861L13.545 39.1887L13.5395 30.9926L6.42182 35.0861ZM32.784 30.9936L32.7895 39.1878L25.6795 35.0868L32.784 30.9936ZM15.2175 30.9936L15.2117 39.1878L22.322 35.0868L15.2175 30.9936ZM35.3004 29.5433L42.4132 25.4406V33.646L35.3004 29.5433ZM5.58754 25.4406V33.646L12.7003 29.5433L5.58754 25.4406ZM16.0572 29.5422L23.1612 33.6346V25.4498L16.0572 29.5422ZM41.5767 23.9993L34.4614 19.9063V28.0922L41.5767 23.9993ZM6.42397 24L13.5393 28.093V19.907L6.42397 24ZM32.7831 19.9072V28.0921L25.6791 23.9996L32.7831 19.9072ZM42.4132 14.354V22.5594L35.3004 18.4567L42.4132 14.354ZM12.7003 18.4567L5.58754 22.5594V14.354L12.7003 18.4567ZM23.1612 14.3639V22.548L16.0577 18.456L23.1612 14.3639ZM41.5796 12.9139L34.4557 8.81089L34.4613 17.0074L41.5796 12.9139ZM13.5457 8.81125L13.5402 17.0074L6.42182 12.9139L13.5457 8.81125ZM32.7895 8.81215L32.784 17.0063L25.6795 12.9132L32.7895 8.81215ZM22.322 12.9132L15.2175 17.0063L15.2117 8.81215L22.322 12.9132ZM31.9577 7.37062L24.8336 3.26792L24.8394 11.4641L31.9577 7.37062Z" fill="black"/>
+</svg>