initial content & placeholders

.github/workflows/publish-github-pages.yml

@@ -0,0 +1,78 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: GitHub Pages
+
+on:
+  # Runs on pushes, if all conditions are met:
+  push:
+    # ... on the website branch ...
+    branches:
+      - 'master'
+    # ... skip tags only ...
+    tags-ignore:
+      - '**'
+    # ... any of these files changes ...
+    paths:
+      - 'website/**'
+      - 'typedoc.json'
+      - '**/tsconfig*.json'
+      - 'src/**/*.ts'
+      - 'README.md'
+      - '.github/workflows/publish-github-pages.yml'
+      - 'package.json'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        # https://github.com/actions/checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 3
+
+      - name: Use Nodejs
+        # https://github.com/actions/setup-node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm --prefix website install
+
+      - name: Build the Docusaurus site
+        run: npm --prefix website run build
+
+      - name: Setup Pages
+        # https://github.com/actions/configure-pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        # https://github.com/actions/upload-pages-artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './website/build'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        # https://github.com/actions/deploy-pages
+        uses: actions/deploy-pages@v4

.gitignore

@@ -4,11 +4,6 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-lerna-debug.log*
-.pnpm-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
 # Runtime data
 pids
@@ -21,110 +16,60 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
-*.lcov
 
 # nyc test coverage
 .nyc_output
 
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
-# Bower dependency directory (https://bower.io/)
-bower_components
-
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (https://nodejs.org/api/addons.html)
+# Compiled binary addons (http://nodejs.org/api/addons.html)
 build/Release
 
 # Dependency directories
-node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
+node_modules
+jspm_packages
 
-# TypeScript cache
-*.tsbuildinfo
+# TypeScript v1 declaration files
+typings/
 
 # Optional npm cache directory
 .npm
 
 # Optional eslint cache
 .eslintcache
 
-# Optional stylelint cache
-.stylelintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
 # Optional REPL history
 .node_repl_history
 
-# Output of 'npm pack'
-*.tgz
+# Archives
+/*.tgz
 
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variable files
+# dotenv environment variables file
 .env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
 
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
+# next.js build output
 .next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-.temp
-.cache
 
-# Docusaurus cache and generated files
-.docusaurus
+.tap
 
-# Serverless directories
-.serverless/
+# ---
 
-# FuseBox cache
-.fusebox/
+/cjs/
+**/*.js.map
+**/*.d.ts
+**/*.d.ts.map
 
-# DynamoDB Local files
-.dynamodb/
+/docs/
 
-# TernJS port file
-.tern-port
+tsconfig.tsbuildinfo
 
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
+/tmp/
 
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
+#end

README.md

@@ -1,2 +1,3 @@
 # web-preview-docusaurus
+
 A preview of the next web site

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "web-preview-docusaurus",
+  "version": "1.0.0",
+  "description": "A preview of the next web site",
+  "main": "",
+  "scripts": {
+    "generate-top-commons": "bash node_modules/@xpack/node-modules-helper/maintenance-scripts/generate-top-commons.sh --init",
+    "create-website": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-commons.sh --init"
+  },
+  "author": {
+    "name": "Liviu Ionescu",
+    "email": "[email protected]",
+    "url": "https://github.com/ilg-ul"
+  },
+  "bugs": {
+    "url": "https://github.com/xpack/web-preview-docusaurus/issues"
+  },
+  "homepage": "https://xpack.github.io/web-preview-docusaurus/",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xpack/web-preview-docusaurus.git"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "json": "^11.0.0",
+    "liquidjs": "^10.18.0"
+  },
+  "bundledDependencies": [],
+  "config": {
+    "isOrganizationWeb": "true"
+  }
+}

website/.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*

website/README.md

@@ -0,0 +1,31 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/),
+a modern static website generator.
+
+The folder was created with:
+
+```sh
+npx create-docusaurus website classic --typescript
+```
+
+## docusaurus-plugin-typedoc
+
+This plugin uses [TypeDoc](https://typedoc.org) to generate
+the reference as markdown pages in `docs/api`.
+
+- https://typedoc-plugin-markdown.org/plugins/docusaurus
+
+```sh
+cd website
+npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
+```
+
+[!NOTE]
+There is a new spec ([TSDoc](https://tsdoc.org)), pushed by
+Microsoft, slightly different, for example there are no
+categories or groups.
+
+[!NOTE]
+There is also another plugin, `docusaurus-plugin-typedoc-api`, but
+it is no longer maintained.

website/babel.config.js

@@ -0,0 +1,6 @@
+// DO NOT EDIT!
+// Automatically generated from docusaurus-template-liquid/templates/docusaurus.
+
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};