Add mdbook

This commit is contained in:
Maximilian Ammann 2021-12-09 20:34:48 +01:00
parent 525a887f4d
commit 15c5f1a165
10 changed files with 51 additions and 0 deletions

View File

@ -44,3 +44,26 @@ jobs:
chmod 600 id_rsa
ssh -o StrictHostKeyChecking=no -i id_rsa max@maxammann.org "rm -f ~/public_html/mapr/*"
rsync -e "ssh -o StrictHostKeyChecking=no -i id_rsa" -r "dist/." max@maxammann.org:~/public_html/mapr/
book:
runs-on: ubuntu-latest
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v2
with:
submodules: 'recursive'
- name: Install mdbook
run: |
cargo install mdbook --no-default-features --features output --vers "^0.1.0"
- name: Build
run: mdbook build docs
- name: Deploy to maxammann.org
env:
SSH_KEY: ${{ secrets.SSH_KEY_MAXAMMANN_ORG }}
run: |
echo "$SSH_KEY" > id_rsa
chmod 600 id_rsa
ssh -o StrictHostKeyChecking=no -i id_rsa max@maxammann.org "rm -f ~/public_html/mapr-docs/*"
rsync -e "ssh -o StrictHostKeyChecking=no -i id_rsa" -r "docs/build/." max@maxammann.org:~/public_html/mapr-docs/

1
docs/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
book

6
docs/book.toml Normal file
View File

@ -0,0 +1,6 @@
[book]
authors = ["Maximilian Ammann"]
language = "en"
multilingual = false
src = "src"
title = "mapr documentation"

16
docs/src/SUMMARY.md Normal file
View File

@ -0,0 +1,16 @@
# mapr documentation
[Introduction](./introduction.md)
## Developer Log
- [Developer Log](./log00-logs.md)
- [Log 01 - WebGPU Stencil](./log01-stencil.md)
- [Log 02 - WASM Shared Memory](./log02-wasm-shared-memory.md)
## Appendix
- [Appendix](./appendix.md)
- [Further Technical Reading](./further_technical_reading.md)

1
docs/src/appendix.md Normal file
View File

@ -0,0 +1 @@
# Appendix

1
docs/src/introduction.md Normal file
View File

@ -0,0 +1 @@
# Introduction

1
docs/src/log00-logs.md Normal file
View File

@ -0,0 +1 @@
# Developer Logs

View File

@ -0,0 +1 @@
# Chapter 1

View File

@ -0,0 +1 @@
# Chapter 1