Skip to content

Commit 4f6b340

Browse files
docs: initialize gitbook
1 parent b3321b4 commit 4f6b340

File tree

8 files changed

+51
-0
lines changed

8 files changed

+51
-0
lines changed

.github/workflows/gh-pages.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Publish GitBook to GH Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- 'master'
7+
8+
9+
jobs:
10+
gh-pages-projection:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: 'Update holobranch: gh-pages'
14+
uses: JarvusInnovations/hologit@actions/projector/v1
15+
env:
16+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17+
HAB_LICENSE: accept
18+
with:
19+
ref: master
20+
holobranch: gh-pages
21+
commit-to: gh-pages
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[hololens]
2+
package = "holo/lens-gitbook"
3+
4+
[hololens.output]
5+
merge = "replace"

.holo/branches/gh-pages/_chime.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[holomapping]
2+
root = "docs"
3+
files = [
4+
"**",
5+
"!.gitignore"
6+
]

.holo/config.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[holospace]
2+
name = "chime"

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
_book/
2+
node_modules/

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# CHIME Documentation
2+
3+
This book is the living documentation for developers and operators working on [the CHIME project](https://github.com/CodeForPhilly/chime) or running instances of it.
4+
5+
It is maintained in the [GitBook format](https://gitbookio.gitbooks.io/docs-toolchain/structure.html) within [the `docs/` directory](https://github.com/CodeForPhilly/chime/tree/master/docs) of the project's main Git repository, and new versions are published automatically upon merge to the `master` branch to: [codeforphilly.github.io/chime](https://codeforphilly.github.io/chime)
6+
7+
To contribute to this book, please [open a pull request against the master branch of github.com/CodeForPhilly/chime](https://github.com/pennsignals/chime/compare/master).

docs/SUMMARY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Table of Contents
2+
3+
- [Introduction](README.md)

docs/book.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"plugins": [
3+
"mermaid@git+https://github.com/JarvusInnovations/gitbook-plugin-mermaid.git"
4+
]
5+
}

0 commit comments

Comments
 (0)