feat: Noosphere docs website skeleton (#456)

* feat: Noosphere docs website skeleton * fix: Relativize everything * fix: No Jekyll * fix: Drawer logo path * chore: Remove vestigial comments Co-authored-by: Justin Abrahms <[email protected]> * fix: Firefox gradient backgrounds --------- Co-authored-by: Justin Abrahms <[email protected]>
subconsciousnetwork · Jun 30, 2023 · 606dfbe · 606dfbe
1 parent 73f016e
commit 606dfbe
Show file tree

Hide file tree

Showing 27 changed files with 4,327 additions and 50 deletions.
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -0,0 +1,33 @@
+on:
+  push:
+    branches:
+      - main
+
+name: Documentation
+
+jobs:
+  build-docs:
+    name: Deploy Noosphere Guide
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: Swatinem/rust-cache@v2
+      - name: 'Setup Rust'
+        run: |
+          curl -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: 'Setup Node.js'
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      - name: 'Build TypeScript packages'
+        run: |
+          cd ./typescript
+          npm ci
+          npm run build
+          touch ./typescript/packages/noosphere-guide/_site/.nojekyll
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: ./typescript/packages/noosphere-guide/_site
diff --git a/typescript/README.md b/typescript/README.md
@@ -10,6 +10,9 @@ The Noosphere TypeScript workspace includes the sources of the following NPM pac
   as Web Assembly).
 - **[`@subconsciousnetwork/sphere-viewer`](./packages/sphere-viewer)**: a simple web app
   that implements read-only access to Noosphere using `@subconsciousnetwork/orb` as a dependency.
+- **[`@subconsciousnetwork/noosphere-guide`](./packages/noosphere-guide)**: an
+  [11ty][eleventy]-based static website generator that produces the Noosphere
+  documentation website.
 
 ## Environment Setup
 
@@ -62,7 +65,8 @@ To run TypeScript tests in headless Chrome:
 npm run test
 ```
 
-And, to start a server to see [Sphere Viewer](./packages/sphere-viewer) in a browser:
+And, to start servers that make both [Sphere Viewer](./packages/sphere-viewer)
+and the [Noosphere Guide](./packages/noosphere-guide) available in web browsers:
 
 ```sh
 npm run serve
@@ -80,3 +84,4 @@ If you only care about a single package, most commands will work if you run them
 [install-nvm]: https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
 [npm-scripts]: https://docs.npmjs.com/cli/v6/using-npm/scripts
 [wireit]: https://github.com/google/wireit
+[eleventy]: https://www.11ty.dev/