Create @mziyut/honkit-plugin-hatena-bookmark-pageowner

.github/workflows/deploy_docs.yml

@@ -0,0 +1,33 @@
+name: Deploy (docs)
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+env:
+  NODE_VERSION: "18"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - run: yarn install
+        working-directory: ./
+      - run: npm i
+        working-directory: ./example
+      - run: npm run build
+        working-directory: ./example
+      - uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: example/_book

.github/workflows/release.yml

@@ -0,0 +1,20 @@
+name: Publish Package to npmjs
+
+on:
+  push:
+    tags:
+      - v*.*.*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          registry-url: "https://registry.npmjs.org"
+      - run: yarn
+      - run: yarn publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+  push:
+
+permissions:
+  contents: read
+
+env:
+  NODE_VERSION: "18"
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: "yarn"
+      - run: yarn install
+      - run: yarn run format
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: "yarn"
+      - run: yarn install
+      - run: yarn run test

.gitignore

@@ -0,0 +1,144 @@
+# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+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
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+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
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# 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
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.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
+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
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+# End of https://www.toptal.com/developers/gitignore/api/node

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Yuta Mizui
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -1,2 +1,36 @@
 # honkit-plugin-hatena-bookmark-pageowner
+
 HonKit plugin for HatenaBookmark pageowner
+
+## How to install
+
+```sh
+npm install @mziyut/honkit-plugin-hatena-bookmark-pageowner
+```
+
+or
+
+```sh
+yarn add @mziyut/honkit-plugin-hatena-bookmark-pageowner
+```
+
+## How to usage
+
+Add settings to book.json
+
+hatenaID cannot be omitted.
+
+```json
+{
+  "plugins": ["@mziyut/honkit-plugin-hatena-bookmark-pageowner"],
+  "pluginsConfig": {
+    "hatena-bookmark-pageowner": {
+      "hateneID": "mziyut112"
+    }
+  }
+}
+```
+
+## References
+
+- [外部サイトをはてな ID と紐付ける（ページオーナー設定） - はてなブックマークヘルプ](https://b.hatena.ne.jp/help/entry/pageowner)

assets/plugin.js

@@ -0,0 +1,13 @@
+require(["gitbook"], function (gitbook) {
+  gitbook.events.bind("start", function (_e, config) {
+    const hateneID = config["hatena-bookmark-pageowner"]["hateneID"] || null;
+
+    if (hateneID) {
+      const link = document.createElement("link");
+      link.rel = "author";
+      link.href = "http://www.hatena.ne.jp/" + hateneID + "/";
+
+      document.head.append(link);
+    }
+  });
+});

example/.gitignore

@@ -0,0 +1 @@
+_book

example/README.md

@@ -0,0 +1,36 @@
+# honkit-plugin-hatena-bookmark-pageowner
+
+HonKit plugin for HatenaBookmark pageowner
+
+## How to install
+
+```sh
+npm install @mziyut/honkit-plugin-hatena-bookmark-pageowner
+```
+
+or
+
+```sh
+yarn add @mziyut/honkit-plugin-hatena-bookmark-pageowner
+```
+
+## How to usage
+
+Add settings to book.json
+
+hatenaID cannot be omitted.
+
+```json
+{
+  "plugins": ["@mziyut/honkit-plugin-hatena-bookmark-pageowner"],
+  "pluginsConfig": {
+    "hatena-bookmark-pageowner": {
+      "hateneID": "mziyut112"
+    }
+  }
+}
+```
+
+## References
+
+- [外部サイトをはてな ID と紐付ける（ページオーナー設定） - はてなブックマークヘルプ](https://b.hatena.ne.jp/help/entry/pageowner)

example/book.json

@@ -0,0 +1,8 @@
+{
+  "plugins": ["@mziyut/honkit-plugin-hatena-bookmark-pageowner"],
+  "pluginsConfig": {
+    "hatena-bookmark-pageowner": {
+      "hateneID": "mziyut112"
+    }
+  }
+}