Skip to content

Commit a164384

Browse files
m1sk9m1sk9
committed
first commit
0 parents  commit a164384

File tree

8 files changed

+147
-0
lines changed

8 files changed

+147
-0
lines changed

‎.github/renovate.json

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": [
4+
"config:recommended"
5+
],
6+
"customManagers": [
7+
{
8+
"customType": "regex",
9+
"fileMatch": ["(^|/)\\.github/workflows/deploy\\.yaml$"],
10+
"matchStrings": ["#\\s?renovate: rust-lang/mdBook\\s*MDBOOK_VERSION:\\s*'(?<currentValue>\\d\\.\\d+\\.\\d+)'"],
11+
"depNameTemplate": "mdbook",
12+
"packageNameTemplate": "rust-lang/mdBook",
13+
"datasourceTemplate": "github-releases"
14+
},
15+
{
16+
"customType": "regex",
17+
"fileMatch": ["(^|/)\\.github/workflows/deploy\\.yaml$"],
18+
"matchStrings": ["#\\s?renovate: slowsage/mdbook-pagetoc\\s*MDBOOK_PAGETOC_VERSION:\\s*'(?<currentValue>\\d\\.\\d+\\.\\d+)'"],
19+
"depNameTemplate": "mdbook-pagetoc",
20+
"packageNameTemplate": "slowsage/mdbook-pagetoc",
21+
"datasourceTemplate": "github-releases"
22+
},
23+
{
24+
"customType": "regex",
25+
"fileMatch": ["(^|/)\\.github/workflows/deploy\\.yaml$"],
26+
"matchStrings": ["#\\s?renovate: lambdalisue/rs-mdbook-alerts\\s*MDBOOK_ALERTS_VERSION:\\s*'(?<currentValue>\\d\\.\\d+\\.\\d+)'"],
27+
"depNameTemplate": "mdbook-alerts",
28+
"packageNameTemplate": "lambdalisue/rs-mdbook-alerts",
29+
"datasourceTemplate": "github-releases"
30+
}
31+
]
32+
}

‎.github/workflows/deploy.yaml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: deploy
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
env:
21+
# renovate: rust-lang/mdBook
22+
MDBOOK_VERSION: '0.4.40'
23+
24+
# renovate: slowsage/mdbook-pagetoc
25+
MDBOOK_PAGETOC_VERSION: '0.2.0'
26+
27+
# renovate: lambdalisue/rs-mdbook-alerts
28+
MDBOOK_ALERTS_VERSION: '0.5.2'
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v4
32+
33+
- name: Setup Pages
34+
uses: actions/configure-pages@v5
35+
36+
- name: Setup Rust
37+
uses: dtolnay/rust-toolchain@stable
38+
39+
- name: Install mdbook
40+
uses: peaceiris/actions-mdbook@v2
41+
with:
42+
mdbook-version: ${{ env.MDBOOK_VERSION }}
43+
44+
- name: Setup cache
45+
uses: Swatinem/rust-cache@v2
46+
with:
47+
prefix-key: "mdbook-template/gh-actions-cache"
48+
49+
- name: Install mdbook plugins
50+
run: |
51+
cargo install mdbook-pagetoc --version ${{ env.MDBOOK_PAGETOC_VERSION }}
52+
cargo install mdbook-alerts --version ${{ env.MDBOOK_ALERTS_VERSION }}
53+
54+
- name: Build with mdbook
55+
run: mdbook build
56+
57+
- name: Upload artifact
58+
uses: actions/upload-pages-artifact@v3
59+
with:
60+
path: ./build
61+
62+
deploy:
63+
environment:
64+
name: github-pages
65+
url: ${{ steps.deployment.outputs.page_url }}
66+
runs-on: ubuntu-latest
67+
needs: build
68+
steps:
69+
- name: Deploy to GitHub Pages
70+
id: deployment
71+
uses: actions/deploy-pages@v4

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
build/
2+
theme/

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Pulsate Project Team
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Pulsate Specification
2+
3+
Documentation of API endpoints, design and other specifications in Pulsate.

‎book.toml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[book]
2+
src = "src"
3+
title = "Pulsate Specification"
4+
language = "ja"
5+
multilingual = false
6+
authors = ["m1sk9 <[email protected]>", "Pulsate Project Team <[email protected]>"]
7+
8+
[build]
9+
build-dir = "build"
10+
create-missing = false
11+
12+
[preprocessor.alerts]
13+
14+
[preprocessor.pagetoc]

‎src/SUMMARY.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Summary
2+
3+
- [Introduction](./introduction.md)

‎src/introduction.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Introduction

0 commit comments

Comments
 (0)