Skip to content

Commit 30ad566

Browse files
committed
Created book skeleton
Also customized theme
1 parent 41e9e33 commit 30ad566

File tree

133 files changed

+15644
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

133 files changed

+15644
-2
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
book
1+
# book
2+
fonts

book.toml

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,173 @@ language = "en"
44
multilingual = false
55
src = "src"
66
title = "Visual and Interactive ML Resources"
7+
8+
9+
[build]
10+
build-dir="book"
11+
create-missing = true # Default: false
12+
use-default-preprocessors = true
13+
14+
# TEXT MODS
15+
16+
[preprocessor.regex]
17+
after=["links","extended-markdown-table"]
18+
patterns = "./src/regex.json"
19+
20+
# [preprocessor.regex-replacer]
21+
# command="mdbook-regex-replacer"
22+
23+
# add your regex rule
24+
# use crates regex
25+
# https://crates.io/crates/regex
26+
# https://docs.rs/regex/1.4.3/regex/#example-replacement-with-named-capture-groups
27+
# [[preprocessor.regex-replacer.items]]
28+
#regex="==(?P<c>.+?)=="
29+
#rep="<mark>$c</mark>"
30+
31+
32+
[preprocessor.extended-markdown-table]
33+
34+
################## DOM TREE MODS
35+
36+
# # https://crates.io/crates/mdbook-last-changed
37+
[preprocessor.last-changed]
38+
command = "mdbook-last-changed"
39+
renderer = ["html"]
40+
41+
################## INDEXING AND BIB
42+
43+
# [preprocessor.index]
44+
# [preprocessor.indexing]
45+
46+
# [preprocessor.tag]
47+
# command = "mdbook-tag"
48+
# Optional key to customize the output filename (defaults to tags.md)
49+
# filename = "customtagsfile.md"
50+
51+
################# TOC
52+
53+
# https://crates.io/crates/mdbook-theme
54+
# [preprocessor.theme] # DON'T USE THIS. IT IS GLITCHY.
55+
# pagetoc = false
56+
57+
# https://github.com/badboy/mdbook-toc
58+
# [preprocessor.toc]
59+
# command = "mdbook-toc"
60+
# renderer = ["html"]
61+
# max-level = 4
62+
63+
[preprocessor.pagetoc]
64+
65+
66+
################## THEME
67+
68+
# [preprocessor.codeblocks]
69+
# renderers = ["html"]
70+
# cpp = { color = "#FFFF99", link = "https://wiki.redmodding.org/red4ext" }
71+
# redscript = { color = "tomato", link = "https://wiki.redmodding.org/redscript" }
72+
# rust = { color = "#ac4313", link = "https://github.com/jac3km4/red4ext-rs" }
73+
# lua = { link = "https://wiki.redmodding.org/cyber-engine-tweaks" }
74+
# swift = { label = "Swift code snippet", color = "skyblue" }
75+
76+
[preprocessors.inline-highlighting]
77+
default-language = "py"
78+
79+
[preprocessor.admonish]
80+
command = "mdbook-admonish"
81+
assets_version = "3.0.1" # do not edit: managed by `mdbook-admonish install`
82+
83+
[preprocessor.catppuccin]
84+
assets_version = "2.1.0" # DO NOT EDIT: Managed by `mdbook-catppuccin install`
85+
86+
#################### EMBED
87+
88+
# [preprocessor.embed]
89+
90+
[preprocessor.webinclude]
91+
92+
#################### DOM ATTR MODS
93+
94+
[preprocessor.links]
95+
96+
########################################### OUTPUT ################################
97+
################### OUTPUT: HTML
98+
99+
[output.html]
100+
theme = "theme"
101+
default-theme = "light"
102+
preferred-dark-theme = "ayu"
103+
curly-quotes = true
104+
mathjax-support = true
105+
copy-fonts = true
106+
additional-css = ['./theme/css/infobox.css','./theme/pagetoc.css','./theme-admonish/mdbook-admonish.css', './theme/css/catppuccin.css', './theme-catppuccin/catppuccin-admonish.css', './theme/css/adjust.css']#, '.\book\css\mdbook-admonish.css']
107+
additional-js = ['./theme/pagetoc.js']
108+
no-section-label = false
109+
git-repository-url = "https://github.com/CheeseTurtle/visual-interactive-ml"
110+
git-repository-icon = "fa-github" # "fa-code-fork"
111+
edit-url-template = "https://github.com/CheeseTurtle/visual-interactive-ml/edit/main/{path}"
112+
# site-url = "/example-book/"
113+
cname = "myproject.rs" # ???
114+
# input-404 = "not-found.md" # Default: "404.md"
115+
116+
[output.html.print]
117+
enable = true # include support for printable output
118+
page-break = true # insert page-break after each chapter
119+
120+
[output.html.fold]
121+
enable = true # whether or not to enable section folding
122+
level = 1 # the depth to start folding
123+
124+
# [output.html.playground]
125+
# editable = false # allows editing the source code
126+
# copyable = true # include the copy button for copying code snippets
127+
# copy-js = true # includes the JavaScript for the code editor
128+
# line-numbers = false # displays line numbers for editable code
129+
# runnable = true # displays a run button for rust code
130+
131+
[output.html.code]
132+
# A prefix string per language (one or more chars).
133+
# Any line starting with whitespace+prefix is hidden.
134+
hidelines = { python = "~" }
135+
136+
[output.html.search]
137+
enable = true # enables the search feature (Default: true)
138+
limit-results = 30 # maximum number of search results (Default: 30)
139+
teaser-word-count = 30 # number of words used for a search result teaser (Default: 30)
140+
use-boolean-and = true # multiple search terms must all match (Default: false)
141+
boost-title = 3 # ranking boost factor for matches in headers (Default: 2)
142+
boost-hierarchy = 2 # ranking boost factor for matches in page names (Default: 1)
143+
boost-paragraph = 1 # ranking boost factor for matches in text (Default: 1)
144+
expand = true # partial words will match longer terms (Default: true)
145+
heading-split-level = 4 # link results to heading levels (Default: 3)
146+
copy-js = true # include Javascript code for search (Default: true)
147+
148+
# [output.html.redirect]
149+
# "/appendices/bibliography.html" = "https://rustc-dev-guide.rust-lang.org/appendix/bibliography.html"
150+
# "/other-installation-methods.html" = "../infra/other-installation-methods.html"
151+
152+
[output.html.playground]
153+
editable = true
154+
# editor = "/path/to/editor" # Default: ace
155+
156+
157+
# OTHER OUTPUT
158+
159+
# [output.wordcount]
160+
# optional = true
161+
# ignores=[]
162+
163+
# [output.markdown]
164+
# optional = true
165+
166+
167+
168+
169+
# {
170+
# "pattern": "(?ms:```infos\\b$\\s+(?P<entry>^\\s*(?P<head>[^\\s:]+[^`\\r\\n\\t:]*)[:\\t]\\s*(?P<tail>[^`\\r\\n]+\\S+)[^`]*$\\s+)+^```)",
171+
# "template": "REPLACED ($entry)"
172+
# },
173+
# {
174+
# "pattern": "(?m:```info\\b(?<nl>\\r?\\n)$(?:(?P<head>[\\S&&^:]+):\\s*(?P<tail>[^\\r\\n`]+)\\r?\\n$)+?^```)",
175+
# "template": "($head): [$tail]$nl"
176+
# }
897 KB
Loading

book/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This file makes sure that Github Pages doesn't process mdBook's output.

book/2023-12-11-13-48-50.png

92.7 KB
Loading

book/2023-12-11-13-48-56.png

92.7 KB
Loading

book/2023-12-11-13-48-58.png

92.7 KB
Loading

book/2023-12-11-13-56-07.png

125 KB
Loading

book/2023-12-11-13-56-14.png

1020 KB
Loading

book/2023-12-11-13-56-20.png

137 KB
Loading

0 commit comments

Comments
 (0)