Docs

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Deploy Docusaurus site to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main  # or the branch you want to deploy from
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'  # Ensure this matches your project's Node.js version
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build Docusaurus site
+        run: npm run build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: build

.github/workflows/static.yml

@@ -20,8 +20,8 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Delete demo/pkg symlink
-        run: rm -fr demo/pkg
+      # - name: Delete demos/vanilla-js/pkg symlink
+      #   run: rm -fr demos/vanilla-js/pkg
 
       - name: Setup Rust Toolchain
         uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -36,14 +36,15 @@ jobs:
 
       - name: Clean and Build with wasm-pack
         run: |
+          cd packages/rust
           cargo clean
           wasm-pack build --target web --release
 
       - name: Prepare Demo Directory
-        run: mkdir -p demo/pkg
+        run: mkdir -p demos/vanilla-js/pkg
 
       - name: Copy Build Artifacts to Demo
-        run: cp -r pkg/* demo/pkg/
+        run: cp -r packages/rust/pkg/* demos/vanilla-js/pkg/
 
       - name: Setup GitHub Pages
         uses: actions/configure-pages@v5

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/docs/api/wrapper/README.md

@@ -0,0 +1,20 @@
+**@notemine/wrapper API v0.0.4** • **Docs**
+
+***
+
+# @notemine/wrapper API v0.0.4
+
+## Classes
+
+- [Notemine](classes/Notemine.md)
+
+## Interfaces
+
+- [BestPowData](interfaces/BestPowData.md)
+- [CancelledEvent](interfaces/CancelledEvent.md)
+- [ErrorEvent](interfaces/ErrorEvent.md)
+- [MinedResult](interfaces/MinedResult.md)
+- [MinerOptions](interfaces/MinerOptions.md)
+- [ProgressEvent](interfaces/ProgressEvent.md)
+- [SuccessEvent](interfaces/SuccessEvent.md)
+- [WorkerPow](interfaces/WorkerPow.md)