Merge pull request #90 from ShellyDCMS/mkdocs

generate mkdocs site

.github/workflows/npm-build.yml

@@ -22,15 +22,8 @@ jobs:
           node-version: 18.18.2
           registry-url: https://registry.npmjs.org/
       - run: npx yarn install --frozen-lockfile
-      - name: "Automated Version Bump"
-        uses: "phips28/gh-action-bump-version@master"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          version-type: "minor"
       - run: npm run build
       - run: npm run cy:run
-      - run: npm run generate-md-docs
       - name: Tests Report
         uses: phoenix-actions/test-reporting@v8
         id: test-report

.github/workflows/npm-publish.yml

@@ -19,12 +19,36 @@ jobs:
           node-version: 18
           registry-url: https://registry.npmjs.org/
       - run: npx yarn install --frozen-lockfile
+      - name: "Automated Version Bump"
+        uses: "phips28/gh-action-bump-version@master"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          version-type: "minor"
+          skip-tag: "true"
+          target-branch: "main"
       - run: npm run build
+      - name: Build the Docs
+        run: |
+          npm run generate-md-docs
+          docker run --rm -v ${PWD}:/docs squidfunk/mkdocs-material build
+      - name: Publish generated content to GitHub Pages
+        uses: tsunematsu21/actions-publish-gh-pages@v1.0.2
+        with:
+          dir: docs
+          branch: gh-pages
+          token: ${{ secrets.ACCESS_TOKEN }}
       - run: npm run cy:run
-      - run: npm run generate-md-docs
-      - name: Generate html docs
-        run: npm run generate-docs
-
+      - name: Build the Docs
+        run: |
+          npm run generate-md-docs          
+          docker run --rm -v ${PWD}:/docs squidfunk/mkdocs-material build
+      - name: Publish generated content to GitHub Pages
+        uses: tsunematsu21/actions-publish-gh-pages@v1.0.2
+        with:
+          dir: site
+          branch: gh-pages
+          token: ${{ secrets.ACCESS_TOKEN }}
       - name: Publish generated content to GitHub Pages
         uses: tsunematsu21/actions-publish-gh-pages@v1.0.2
         with:

mkdocs.yml

@@ -0,0 +1,29 @@
+site_name: Cypress Test Utils
+site_url: ""
+use_directory_urls: false
+plugins: []
+theme:
+  name: material
+  palette:
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - content.code.copy
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - toc.follow
+    - search.suggest
+    - navigation.instant
+    - navigation.sections
+    - navigation.top # back to top button

src/assertable.ts

@@ -495,6 +495,7 @@ export class Assertable<T> {
  *  };
  *  public then = (chainable: Cypress.Chainable<any>) => new MyAssertable(chainable);
  * }
+ * ```
  */
 export const then = (subject: Cypress.Chainable<any> | any) => {
   return new Assertable(

typedoc.md.json

@@ -13,7 +13,7 @@
     "./src/lit/index.ts",
     "./src/assertable.ts"
   ],
-  "out": "documents",
+  "out": "docs",
   "disableSources": true,
   "githubPages": false
 }