Initial commit

.github/dependabot.yaml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    assignees:
+      - 'kubosho'
+    directory: '/'
+    schedule:
+      interval: weekly
+      time: '10:00'
+      timezone: Asia/Tokyo
+    versioning-strategy: increase
+    open-pull-requests-limit: 50

.github/workflows/release.yaml

@@ -0,0 +1,32 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Release script
+        run: npx semantic-release
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}

.github/workflows/textlint.yaml

@@ -0,0 +1,33 @@
+name: Text check by Textlint
+on:
+  push:
+    branches: [main, master]
+    paths:
+      - 'entries/**.md'
+  pull_request:
+    branches: [main, master]
+    paths:
+      - 'entries/**.md'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: v20.17.0
+
+      - name: Package Install
+        run: npm install
+
+      - name: Exec Textlint
+        run: |
+          git diff origin/${GITHUB_BASE_REF}..origin/${GITHUB_HEAD_REF} \
+            --diff-filter=AM \
+            --name-only -- '*.md' \
+            | xargs npm run lint

.gitignore

@@ -0,0 +1,190 @@
+# ------------------------------
+# Project
+# ------------------------------
+
+.temp/
+dist/
+
+# ------------------------------
+# macOS
+# ------------------------------
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# ------------------------------
+# Windows
+# ------------------------------
+
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# ------------------------------
+# Node.js
+# ------------------------------
+
+# 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
+
+# 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 variables file
+.env
+.env.test
+.env.production
+
+# 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
+
+# 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-version

@@ -0,0 +1 @@
+20.17.0

.prettierignore

@@ -0,0 +1,3 @@
+.temp/
+out/
+yarn.lock

.prettierrc.js

@@ -0,0 +1,5 @@
+const config = require('@kubosho/configs/prettier');
+
+module.exports = {
+  ...config,
+};

.textlintrc.js

@@ -0,0 +1,5 @@
+const config = require('@kubosho/configs/textlint');
+
+module.exports = {
+  ...config,
+};

CHANGELOG.md

@@ -0,0 +1,21 @@
+## 1.0.0 (2024-09-23)
+
+### ✨ Features
+
+* **entries:** replace contents ([d94227b](https://github.com/o2project/techbook-template/commit/d94227b5632acb796bcd81b2e2babe0b42da8e9d))
+
+### 🐛 Bug Fixes
+
+* **vivliostyle:** correct PDF output destination ([566cf17](https://github.com/o2project/techbook-template/commit/566cf17bb9bac3c6c9310ccc25b2d8c4d4cd3603))
+* **entries:** fix lint error ([1b04761](https://github.com/o2project/techbook-template/commit/1b04761b635caf6b1ffe1ef908b5c49d25ce5404))
+* **entries:** fix text ([f6d9ca2](https://github.com/o2project/techbook-template/commit/f6d9ca2ac08f6b8225621908a5c3d140b1d3c35d))
+
+### 📚 Some changes
+
+* **README:** add README ([9b30b85](https://github.com/o2project/techbook-template/commit/9b30b85aa75528cc1f626466444eecfff5d711ae))
+* **vivliostyle:** reduce scope of environment variable-based branching ([3dfe480](https://github.com/o2project/techbook-template/commit/3dfe48037e7327f08404b1900dc478b58889f656))
+* **deps:** remove yarn.lock ([a0dcda5](https://github.com/o2project/techbook-template/commit/a0dcda5733f7f891731f997c6a1ec70b2cbb4b1b))
+* **deps:** update @kubosho/configs ([60bd2d9](https://github.com/o2project/techbook-template/commit/60bd2d9d22057c9b10c480587ace36f2e4f63286))
+* **deps:** update @o2project/vivliostyle-theme-o2project version ([c8b2cb9](https://github.com/o2project/techbook-template/commit/c8b2cb9258f090c2e2e08701669006ee7de47b46))
+* **README:** update development commands ([13665a6](https://github.com/o2project/techbook-template/commit/13665a612ce938c529a40c9a65a63a19fc6afcfb))
+* **entries/introduction:** update sample page ([a3a682d](https://github.com/o2project/techbook-template/commit/a3a682de7ae94d319f4156e66d9c73110c62160c))

LICENSE.md

@@ -0,0 +1,29 @@
+Source Code released under the MIT License
+
+Copyright (c) 2021 O2 Project
+
+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.
+
+---
+
+The text content released under the CC BY 4.0.
+
+Copyright (c) 2021 O2 Project
+
+https://creativecommons.org/licenses/by/4.0

README.md

@@ -0,0 +1,29 @@
+# Techbook Template
+
+Techbook boilerplate repository.
+
+## Install dependencies
+
+```
+npm install
+```
+
+## Build
+
+```
+npm run build
+```
+
+## Preview
+
+```
+npm run dev
+```
+
+## Test
+
+Run [Textlint](https://github.com/textlint/textlint).
+
+```
+npm run lint
+```