Skip to content

Commit

Permalink
docs: init mdbook
Browse files Browse the repository at this point in the history
  • Loading branch information
dhommen authored Jan 23, 2024
1 parent 0e411e6 commit 14ce92d
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 416 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Deploy to Github-Pages

on:
push:
branches: ["main"]
paths: ["docs/**"]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: mdBook Action
uses: peaceiris/actions-mdbook@v1

- run: mdbook build

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book

6 changes: 6 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[book]
authors = ["M.Schoenenberg, D.Hommen"]
language = "en"
multilingual = false
src = "docs"
title = "Documentation"
5 changes: 5 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Summary

- [Installation]()
- [Use]()
- [Developing]()
Loading

0 comments on commit 14ce92d

Please sign in to comment.