Merge pull request #2 from kiwigrid/feature/prepare-release

prepare for first release

.github/workflows/.github/workflows/release-main.yml

@@ -0,0 +1,28 @@
+on:
+  push:
+    branches:
+      - main
+name: release-please
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GoogleCloudPlatform/[email protected]
+        id: release
+      # The logic below handles the npm publication:
+      - uses: actions/checkout@v4
+        # these if statements ensure that a publication only occurs when
+        # a new release is created:
+        if: ${{ steps.release.outputs.release_created }}
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+          registry-url: 'https://registry.npmjs.org'
+        if: ${{ steps.release.outputs.release_created }}
+      - run: npm ci
+        if: ${{ steps.release.outputs.release_created }}
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+        if: ${{ steps.release.outputs.release_created }}

.nvmrc

@@ -0,0 +1 @@
+18

README.md

@@ -146,23 +146,15 @@ antora:
   extensions:
     - require: "@kiwigrid/antora-main-menu"
       hbs: 
-        menu: <Main template>
-        group_start: <Group beginning template>
-        group_end: <Group end template>
-        document_ref: <Document reference template>
+        menu: <Main template>                         # default main-menu
+        group_start: <Group beginning template>       # default main-menu-group-start
+        group_end: <Group end template>               # default main-menu-group-end
+        document_ref: <Document reference template>   # default main-menu-docref
 ```
-
-The default values are:
-
-* menu: `main-menu`
-* group_start: `main-menu-group-start`
-* group_end: `main-menu-group-end`
-* document_ref: `main-menu-docref`
-
 The templates are supporting the following parameter:
 
-#### main-menu
-No parameter
+* main-menu: No parameter
+* main-menu-group-end: No parameter
 
 
 #### main-menu-group-start

package.json

@@ -3,15 +3,18 @@
   "version": "1.0.0",
   "description": "Antora 3 extension to generate a dynamic main menu.",
   "contributors": [
-    { "name":  "Sven Krause", "email":  "[email protected]"}
+    {
+      "name": "Sven Krause",
+      "email": "[email protected]"
+    }
   ],
   "license": "MIT",
   "type": "commonjs",
   "main": "extensions/v1/index.js",
   "dependencies": {
+    "handlebars": "^4.7.7",
     "js-yaml": "^4.1.0",
-    "vinyl": "^2.2.1",
-    "handlebars": "^4.7.7"
+    "vinyl": "^2.2.1"
   },
   "peerDependencies": {
     "@antora/cli": "3.1.3"