feat: add mdbook

This commit is contained in:
Sevki 2024-03-15 12:16:55 +00:00 committed by GitHub
parent 1ef3ed6d79
commit 0e5b27754a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 36 additions and 1 deletions

2
.gitignore vendored
View file

@ -1 +1 @@
/target
docs/book

7
Cargo.lock generated Normal file
View file

@ -0,0 +1,7 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 3
[[package]]
name = "okrust"
version = "0.1.0"

10
README.md Normal file
View file

@ -0,0 +1,10 @@
<img src="docs/src/okRust.png" width="200" height="200" align="right" alt="okRust logo">
# okRust
okrust is the template for new rust projects within oknotok.computer.
It has some opinionated defaults, like using:
- mdBook for documentation
- release please for releases
- github actions for CI/CD

5
book.toml Normal file
View file

@ -0,0 +1,5 @@
[book]
authors = ["sevki"]
language = "en"
multilingual = false
src = "docs"

3
docs/src/SUMMARY.md Normal file
View file

@ -0,0 +1,3 @@
# Summary
- [Intro](intro.md)

10
docs/src/intro.md Normal file
View file

@ -0,0 +1,10 @@
# okRust
<img src="okRust.png" width="200" height="200" align="right" alt="okRust logo">
okrust is the template for new rust projects within oknotok.computer.
It has some opinionated defaults, like using:
- mdBook for documentation
- release please for releases
- github actions for CI/CD

BIN
docs/src/okRust.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 273 KiB