Skip to content

Commit

Permalink
docs: change book.toml and add todos
Browse files Browse the repository at this point in the history
  • Loading branch information
asandikci committed Dec 17, 2023
1 parent 841b197 commit bca7a71
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
18 changes: 18 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
2 changes: 1 addition & 1 deletion src/dev/pardus-bireysel/functions/common.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `common.sh`

```bash,editable
```bash,mdbook-runnable
_log
# feature rich logs with color support
# $1 : log text
Expand Down
4 changes: 3 additions & 1 deletion src/dev/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,6 @@
### `docs` Roadmap
- [ ] Multilanguage Support (TR/EN)
- [ ] Index and 404 page support
- [ ] runnable scripts support
- [ ] 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

0 comments on commit bca7a71

Please sign in to comment.