mirror of
https://github.com/anoma/juvix.git
synced 2024-12-04 17:07:28 +03:00
22ba8f15fd
In this PR, I have updated the README file to reflect the new goals of the project and highlight related products to Juvix. The ORG files have been replaced with Markdown for better readability and maintainability. Additionally, I have added a couple of files to fine-tune the mdbook settings. These changes, I believe, will make it easier for users to understand and contribute to the project.🤞 - Closes #1878 - New pre-commit hook to format md, yaml, js, CSS files. To check the website generation, I have deployed the result here: Work in progress. - https://jonaprieto.github.io/juvix - https://github.com/jonaprieto/juvix --------- Co-authored-by: Paul Cadman <pcadman@gmail.com> Co-authored-by: Christopher Goes <cwgoes@pluranimity.org> Co-authored-by: Jan Mas Rovira <janmasrovira@gmail.com>
61 lines
2.0 KiB
TOML
61 lines
2.0 KiB
TOML
[book]
|
|
title = "The Juvix Book"
|
|
authors = [ "Jonathan Prieto-Cubides" , "Jan Mas Rovira" , "Paul Cadman" , "Lukasz Czajka" ]
|
|
language = "en"
|
|
multilingual = false
|
|
src = "docs"
|
|
|
|
[build]
|
|
create-missing = true
|
|
|
|
[preprocessor.index]
|
|
|
|
[preprocessor.links]
|
|
|
|
[preprocessor.pagetoc]
|
|
|
|
[preprocessor.katex]
|
|
renderers = ["html"]
|
|
static-css = false
|
|
include-src = false
|
|
block-delimiter = {left = "$$", right = "$$"}
|
|
inline-delimiter = {left = "$", right = "$"}
|
|
macros = "theme/latex-macros.txt"
|
|
|
|
[output.katex]
|
|
|
|
[output.html]
|
|
default-theme = "light"
|
|
preferred-dark-theme = "Ayu"
|
|
copy-fonts = true
|
|
additional-css = ["theme/pagetoc.css"]
|
|
additional-js = ["theme/pagetoc.js","assets/images/tara-magicien.png", "assets/images/tara-seating.svg", "assets/images/tara-smiling.png", "assets/images/tara-smiling.svg", "assets/images/tara-teaching.png", "assets/images/tara-teaching.svg", "assets/js/highlight.js", "assets/js/tex-chtml.js" ]
|
|
no-section-label = false
|
|
git-repository-url = "https://github.com/anoma/juvix"
|
|
git-repository-icon = "fa-github"
|
|
|
|
[output.html.fold]
|
|
enable = true # whether or not to enable section folding
|
|
level = 0 # the depth to start folding
|
|
|
|
[output.html.search]
|
|
enable = true # enables the search feature
|
|
limit-results = 15 # maximum number of search results
|
|
teaser-word-count = 30 # number of words used for a search result teaser
|
|
use-boolean-and = true # multiple search terms must all match
|
|
boost-title = 2 # ranking boost factor for matches in headers
|
|
boost-hierarchy = 1 # ranking boost factor for matches in page names
|
|
boost-paragraph = 1 # ranking boost factor for matches in text
|
|
expand = true # partial words will match longer terms
|
|
heading-split-level = 2 # link results to heading levels
|
|
copy-js = true # include Javascript code for search
|
|
|
|
[output.linkcheck]
|
|
follow-web-links = false
|
|
traverse-parent-directories = false
|
|
exclude = [ ]
|
|
user-agent = "mdbook-linkcheck-0.4.0"
|
|
cache-timeout = 43200
|
|
[output.linkcheck.http-headers]
|
|
'crates\.io' = ["Accept: text/html"]
|