feat: skeleton docs (#67)

dyne · Jan 17, 2024 · 946014e · 946014e
1 parent dc38aa6
commit 946014e
Show file tree

Hide file tree

Showing 16 changed files with 70 additions and 25 deletions.
diff --git a/.gitignore b/.gitignore
@@ -42,8 +42,6 @@
 !/pkg/browser/public/index.html
 
 # shitdocs
-!/docs/*.html
-!/docs/*.mjs
-!/docs/*.json
+!/docs/**
 
-node_modules
+node_modules
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,2 @@
+# Slangroom
+
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,9 @@
+* [Home](/)
+* Tutorials
+  * [Quickstart](tutorials/quickstart)
+  * [Setup dev environment](tutorials/dev)
+  * [Write you own plugin](tutorials/plugin)
+
+* Railroads
+  * [Http](railroads/http)
+  * [Wallet](railroads/wallet)
diff --git a/docs/index.html b/docs/index.html
@@ -1,28 +1,23 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Dyne.org slangroom documentation</title>
-    <link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css"/>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
 </head>
 <body>
-  <header>
-    <h1>slangˑroom</h1>
-  </header>
-
-  <main>
-    <ul>
-      <li><a href="./wallet.html">@slangroom/wallet</a></li>
-      <li><a href="./http.html">@slangroom/http</a></li>
-      <li><a href="./ethereum.html">@slangroom/ethereum</a></li>
-    </ul>
-  </main>
-
-  <footer>
-    <p>
-  Made with <3 by Dyne.org's hackers
-    </p>
-  </footer>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      loadSidebar: true,
+      name: 'Slangroom',
+      repo: 'https://github.com/dyne/slangroom'
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
 </body>
 </html>
diff --git a/docs/ethereum.html → docs/railroads/ethereum.html b/docs/ethereum.html → docs/railroads/ethereum.html
diff --git a/docs/generate_syntax.mjs → docs/railroads/generate_syntax.mjs b/docs/generate_syntax.mjs → docs/railroads/generate_syntax.mjs
diff --git a/docs/http.html → docs/railroads/http.html b/docs/http.html → docs/railroads/http.html
diff --git a/docs/railroads/http.md b/docs/railroads/http.md
@@ -0,0 +1,2 @@
+# Http plugin
+[http.html](http.html ':include')
diff --git a/docs/railroads/index.html b/docs/railroads/index.html
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Dyne.org slangroom documentation</title>
+    <link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css"/>
+</head>
+<body>
+  <header>
+    <h1>slangˑroom</h1>
+  </header>
+
+  <main>
+    <ul>
+      <li><a href="./wallet.html">@slangroom/wallet</a></li>
+      <li><a href="./http.html">@slangroom/http</a></li>
+      <li><a href="./ethereum.html">@slangroom/ethereum</a></li>
+    </ul>
+  </main>
+
+  <footer>
+    <p>
+  Made with <3 by Dyne.org's hackers
+    </p>
+  </footer>
+</body>
+</html>
diff --git a/docs/package.json → docs/railroads/package.json b/docs/package.json → docs/railroads/package.json
diff --git a/docs/wallet.html → docs/railroads/wallet.html b/docs/wallet.html → docs/railroads/wallet.html
diff --git a/docs/railroads/wallet.md b/docs/railroads/wallet.md
@@ -0,0 +1,2 @@
+# Wallet plugin
+[wallet.html](wallet.html ':include')
diff --git a/docs/tutorials/dev.md b/docs/tutorials/dev.md
@@ -0,0 +1,3 @@
+# Dev environment
+
+TODO Setup pnpm, pnpm build, pnpm test, pnpm clean
diff --git a/docs/tutorials/plugin.md b/docs/tutorials/plugin.md
@@ -0,0 +1,3 @@
+# Write you own plugin
+
+TODO: ....
diff --git a/docs/tutorials/quickstart.md b/docs/tutorials/quickstart.md
@@ -0,0 +1,3 @@
+# Quickstart
+
+TODO Write a simple javascript script that uses slangroom....