From bca7a7184f714919972cbbf26031bed2f5a74dcc Mon Sep 17 00:00:00 2001 From: asandikci Date: Sun, 17 Dec 2023 17:55:08 +0300 Subject: [PATCH] docs: change book.toml and add todos --- .github/workflows/deploy.yml | 1 + book.toml | 18 ++++++++++++++++++ src/dev/pardus-bireysel/functions/common.md | 2 +- src/dev/roadmap.md | 4 +++- 4 files changed, 23 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index cb31284..1ed2625 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -25,6 +25,7 @@ jobs: run: | # This assumes your book is in the root of your repository. # Just add a `cd` here if you need to change to another directory. + cargo install mdbook-cmdrun mdbook build git worktree add gh-pages git config user.name "Deploy from CI" diff --git a/book.toml b/book.toml index b3fe6f5..901de6f 100644 --- a/book.toml +++ b/book.toml @@ -5,5 +5,23 @@ multilingual = false src = "src" title = "Pardus Bireysel Dökümantasyonu" +[output.html] +mathjax-support = true +site-url = "/docs/" +git-repository-url = "https://github.com/pardus-bireysel/docs/tree/main/" +edit-url-template = "https://github.com/pardus-bireysel/docs/tree/main/{path}" + [output.html.playground] editable = true +line-numbers = true + +[output.html.search] +limit-results = 20 +use-boolean-and = true +boost-title = 2 +boost-hierarchy = 2 +boost-paragraph = 1 +expand = true +heading-split-level = 2 + +[preprocessor.cmdrun] \ No newline at end of file diff --git a/src/dev/pardus-bireysel/functions/common.md b/src/dev/pardus-bireysel/functions/common.md index 68c920d..cec12e4 100644 --- a/src/dev/pardus-bireysel/functions/common.md +++ b/src/dev/pardus-bireysel/functions/common.md @@ -1,6 +1,6 @@ # `common.sh` -```bash,editable +```bash,mdbook-runnable _log # feature rich logs with color support # $1 : log text diff --git a/src/dev/roadmap.md b/src/dev/roadmap.md index 27d660f..ea26ba2 100644 --- a/src/dev/roadmap.md +++ b/src/dev/roadmap.md @@ -35,4 +35,6 @@ ### `docs` Roadmap - [ ] Multilanguage Support (TR/EN) - [ ] Index and 404 page support -- [ ] runnable scripts support \ No newline at end of file +- [ ] runnable bash scripts support +- [ ] Add useful tools like in https://rust-lang.github.io/mdBook/for_developers/backends.html +- [ ] Look https://rust-lang.github.io/mdBook/for_developers/preprocessors.html \ No newline at end of file