From 31f865b5c86baf369642178f65aa72c9d7e5ffa3 Mon Sep 17 00:00:00 2001
From: Joshua Ramon Enslin <joshua@jrenslin.de>
Date: Sat, 1 Jan 2022 02:50:31 +0100
Subject: [PATCH] Initialize mdbook

---
 .gitignore       |  1 +
 book.toml        | 51 ++++++++++++++++++++++++++++++++++++++++++++++++
 src/SUMMARY.md   |  3 +++
 src/chapter_1.md |  1 +
 4 files changed, 56 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 book.toml
 create mode 100644 src/SUMMARY.md
 create mode 100644 src/chapter_1.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..7585238
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/book.toml b/book.toml
new file mode 100644
index 0000000..483e489
--- /dev/null
+++ b/book.toml
@@ -0,0 +1,51 @@
+[book]
+authors = ["Joshua Ramon Enslin"]
+language = "en"
+multilingual = false
+src = "src"
+title = "museum-digital:handbook"
+description = "English language handbook for museum-digital"
+
+[preprocessor.index]
+
+[preprocessor.links]
+
+[output.html.print]
+enable = true
+
+[output.html.fold]
+enable = false
+level = 0
+
+[output.linkcheck]
+# Should we check links on the internet? Enabling this option adds a
+# non-negligible performance impact
+follow-web-links = true
+
+# Are we allowed to link to files outside of the book's root directory? This
+# may help prevent linking to sensitive files (e.g. "../../../../etc/shadow")
+traverse-parent-directories = true
+
+# If necessary, you can exclude one or more links from being checked with a
+# list of regular expressions. The regex will be applied to the link href (i.e.
+# the `./index.html` in `[some page](./index.html)`) so it can be used to
+# ignore both web and filesystem links.
+#
+# Hint: you can use TOML's raw strings (single quote) to avoid needing to
+# escape things twice.
+exclude = [ 'google\.com|php\.net' ]
+
+# The User-Agent to use when sending web requests
+# user-agent = "mdbook-linkcheck-0.4.0"
+user-agent = "mdbook-linkcheck-0.4.0"
+
+# The number of seconds a cached result is valid for (12 hrs by default)
+cache-timeout = 43200
+
+# How should warnings be treated?
+#
+# - "warn" will emit warning messages
+# - "error" treats all warnings as errors, failing the linkcheck
+# - "ignore" will ignore warnings, suppressing diagnostic messages and allowing
+#   the linkcheck to continuing
+warning-policy = "warn"
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
new file mode 100644
index 0000000..7390c82
--- /dev/null
+++ b/src/SUMMARY.md
@@ -0,0 +1,3 @@
+# Summary
+
+- [Chapter 1](./chapter_1.md)
diff --git a/src/chapter_1.md b/src/chapter_1.md
new file mode 100644
index 0000000..b743fda
--- /dev/null
+++ b/src/chapter_1.md
@@ -0,0 +1 @@
+# Chapter 1