mirror of
https://github.com/matrix-org/matrix-hookshot.git
synced 2025-03-10 21:19:13 +00:00
Add skeleton for docs
This commit is contained in:
parent
9fe696827f
commit
65a7d96644
29
.github/workflows/docs.yml
vendored
Normal file
29
.github/workflows/docs.yml
vendored
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
name: Build docs
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Setup mdBook
|
||||||
|
uses: peaceiris/actions-mdbook@v1
|
||||||
|
with:
|
||||||
|
mdbook-version: '0.4.11'
|
||||||
|
|
||||||
|
- run: mdbook build
|
||||||
|
|
||||||
|
- name: Deploy latest
|
||||||
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
keep_files: true
|
||||||
|
publish_dir: ./book
|
||||||
|
destination_dir: ./
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -10,3 +10,5 @@ public/
|
|||||||
.idea
|
.idea
|
||||||
# Added by cargo
|
# Added by cargo
|
||||||
/target
|
/target
|
||||||
|
|
||||||
|
book
|
6
book.toml
Normal file
6
book.toml
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
[book]
|
||||||
|
authors = ["Half-Shot <me@half-shot.uk>"]
|
||||||
|
language = "en"
|
||||||
|
multilingual = false
|
||||||
|
src = "docs"
|
||||||
|
title = "Matrix Hookshot"
|
9
docs/SUMMARY.md
Normal file
9
docs/SUMMARY.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# Summary
|
||||||
|
|
||||||
|
- [Hookshot](./hookshot.md)
|
||||||
|
- [Features](./features.md)
|
||||||
|
- [Setup](./setup.md)
|
||||||
|
- [GitHub](./setup/github.md)
|
||||||
|
- [GitLab](./setup/gitlab.md)
|
||||||
|
- [JIRA](./setup/jira.md)
|
||||||
|
- [Webhooks](./setup/webhooks.md)
|
1
docs/features.md
Normal file
1
docs/features.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Features
|
1
docs/hookshot.md
Normal file
1
docs/hookshot.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Chapter 1
|
0
docs/setup.md
Normal file
0
docs/setup.md
Normal file
1
docs/setup/github.md
Normal file
1
docs/setup/github.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# GitHub
|
1
docs/setup/gitlab.md
Normal file
1
docs/setup/gitlab.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# GitLab
|
1
docs/setup/jira.md
Normal file
1
docs/setup/jira.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# JIRA
|
1
docs/setup/webhooks.md
Normal file
1
docs/setup/webhooks.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Webhooks
|
Loading…
x
Reference in New Issue
Block a user