Update GitHub pages

Ntsekees · Oct 18, 2024 · e5740fa · e5740fa
1 parent 8335248
commit e5740fa
Show file tree

Hide file tree

Showing 68 changed files with 11,974 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/bins/LICENSE b/bins/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Michael Bryan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/bins/README.md b/bins/README.md
@@ -0,0 +1,166 @@
+# MDBook Link-Check
+
+[![Continuous integration](https://github.com/Michael-F-Bryan/mdbook-linkcheck/workflows/Continuous%20integration/badge.svg?branch=master)](https://github.com/Michael-F-Bryan/mdbook-linkcheck/actions)
+[![Crates.io](https://img.shields.io/crates/v/mdbook-linkcheck.svg)](https://crates.io/crates/mdbook-linkcheck)
+[![Docs.rs](https://docs.rs/mdbook-linkcheck/badge.svg)](https://docs.rs/mdbook-linkcheck/)
+[![license](https://img.shields.io/github/license/michael-f-bryan/mdbook-linkcheck.svg)](https://github.com/Michael-F-Bryan/mdbook-linkcheck/blob/master/LICENSE)
+
+A backend for `mdbook` which will check your links for you. For use alongside
+the built-in HTML renderer.
+
+## Getting Started
+
+First you'll need to install `mdbook-linkcheck`.
+
+```
+cargo install mdbook-linkcheck
+```
+
+If you don't want to install from source (which often takes a while) you can
+grab an executable from [GitHub Releases][releases] or use this line of
+`curl`:
+
+```console
+curl -s https://api.github.com/repos/Michael-F-Bryan/mdbook-linkcheck/releases/latest \
+    | grep browser_download_url \
+    | grep $(rustc -Vv | grep host | cut -d' ' -f2) \
+    | cut -d : -f 2,3 \
+    | tr -d \" \
+    | wget -qi -
+```
+
+Next you'll need to update your `book.toml` to let `mdbook` know it needs to
+use `mdbook-linkcheck` as a backend.
+
+```toml
+[book]
+title = "My Awesome Book"
+authors = ["Michael-F-Bryan"]
+
+[output.html]
+
+[output.linkcheck]
+```
+
+And finally you should be able to run `mdbook build` like normal and everything
+should *Just Work*.
+
+```
+$ mdbook build
+```
+
+> **Note:** When multiple `[output]` items are specified, `mdbook` tries to
+> ensure that each `[output]` gets its own sub-directory within the `build-dir`
+> (`book/` by default).
+>
+> That means if you go from only having the HTML renderer enabled to enabling
+> both HTML and the linkchecker, your HTML will be placed in `book/html/`
+> instead of just `book/` like before.
+
+## Configuration
+
+The link checker's behaviour can be configured by setting options under the
+`output.linkcheck` table in your `book.toml`.
+
+```toml
+...
+
+[output.linkcheck]
+# Should we check links on the internet? Enabling this option adds a
+# non-negligible performance impact
+follow-web-links = false
+
+# 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 = false
+
+# 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' ]
+
+# The User-Agent to use when sending web requests
+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"
+
+# Extra HTTP headers that must be send to certain web sites
+# in order to link check to succeed.
+#
+# This is a dictionary (map), with keys being regexes
+# matching a set of web sites, and values being an array of
+# the headers.
+[output.linkcheck.http-headers]
+# Any hyperlink that contains this regexp will be sent
+# the "Accept: text/html" header
+'crates\.io' = ["Accept: text/html"]
+
+# mdbook-linkcheck will interpolate environment variables into your header via
+# $IDENT.
+#
+# If this is not what you want you must escape the `$` symbol, like `\$TOKEN`.
+# `\` itself can also be escaped via `\\`.
+#
+# Note: If interpolation fails, the header will be skipped and the failure will
+# be logged. This can be useful if a particular header isn't always necessary,
+# but may be helpful (e.g. when working with rate limiting).
+'website\.com' = ["Authorization: Basic $TOKEN"]
+```
+
+## Continuous Integration
+
+Incorporating `mdbook-linkcheck` into your CI system should be straightforward
+if you are already [using `mdbook` to generate documentation][mdbook-ci].
+
+For those using GitLab's built-in CI:
+
+```yaml
+generate-book:
+  stage: build
+  image:
+    name: michaelfbryan/mdbook-docker-image:latest
+    entrypoint: [""]
+  script:
+    - mdbook build $BOOK_DIR
+  artifacts:
+    paths:
+      - $BOOK_DIR/book/html
+    # make sure GitLab doesn't accidentally keep every book you ever generate
+    # indefinitely
+    expire_in: 1 week
+
+pages:
+  image: busybox:latest
+  stage: deploy
+  dependencies:
+    - generate-book
+  script:
+    - cp -r $BOOK_DIR/book/html public
+  artifacts:
+    paths:
+    - public
+  only:
+    - master
+```
+
+The [michaelfbryan/mdbook-docker-image][image] docker image is also available
+on Docker hub and comes with the latest version of `mdbook` and
+`mdbook-linkcheck` pre-installed.
+
+[releases]: https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases
+[mdbook-ci]: https://rust-lang.github.io/mdBook/continuous-integration.html
+[Michael-F-Bryan]: https://github.com/Michael-F-Bryan
+[image]: https://hub.docker.com/r/michaelfbryan/mdbook-docker-image
diff --git a/bins/linkcheck.zip b/bins/linkcheck.zip
diff --git a/bins/mdbook b/bins/mdbook
diff --git a/bins/mdbook-linkcheck b/bins/mdbook-linkcheck
diff --git a/grammar/book/.nojekyll b/grammar/book/.nojekyll
@@ -0,0 +1 @@
+This file makes sure that Github Pages doesn't process mdBook's output.
diff --git a/grammar/book/404.html b/grammar/book/404.html
@@ -0,0 +1,167 @@
+<!DOCTYPE HTML>
+<html lang="en" class="sidebar-visible no-js light">
+    <head>
+        <!-- Book generated using mdBook -->
+        <meta charset="UTF-8">
+        <title>Page not found - Nahaıwa grammar</title>
+        <base href="/">
+        <!-- Custom HTML head -->
+        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+        <meta name="description" content="">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <meta name="theme-color" content="#ffffff" />
+
+        <link rel="icon" href="favicon.svg">
+        <link rel="shortcut icon" href="favicon.png">
+        <link rel="stylesheet" href="css/variables.css">
+        <link rel="stylesheet" href="css/general.css">
+        <link rel="stylesheet" href="css/chrome.css">
+        <link rel="stylesheet" href="css/print.css" media="print">
+        <!-- Fonts -->
+        <link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
+        <link rel="stylesheet" href="fonts/fonts.css">
+        <!-- Highlight.js Stylesheets -->
+        <link rel="stylesheet" href="highlight.css">
+        <link rel="stylesheet" href="tomorrow-night.css">
+        <link rel="stylesheet" href="ayu-highlight.css">
+
+        <!-- Custom theme stylesheets -->
+    </head>
+    <body>
+        <!-- Provide site root to javascript -->
+        <script type="text/javascript">
+            var path_to_root = "";
+            var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
+        </script>
+
+        <!-- Work around some values being stored in localStorage wrapped in quotes -->
+        <script type="text/javascript">
+            try {
+                var theme = localStorage.getItem('mdbook-theme');
+                var sidebar = localStorage.getItem('mdbook-sidebar');
+
+                if (theme.startsWith('"') && theme.endsWith('"')) {
+                    localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
+                }
+
+                if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
+                    localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
+                }
+            } catch (e) { }
+        </script>
+
+        <!-- Set the theme before any content is loaded, prevents flash -->
+        <script type="text/javascript">
+            var theme;
+            try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
+            if (theme === null || theme === undefined) { theme = default_theme; }
+            var html = document.querySelector('html');
+            html.classList.remove('no-js')
+            html.classList.remove('light')
+            html.classList.add(theme);
+            html.classList.add('js');
+        </script>
+
+        <!-- Hide / unhide sidebar before it is displayed -->
+        <script type="text/javascript">
+            var html = document.querySelector('html');
+            var sidebar = 'hidden';
+            if (document.body.clientWidth >= 1080) {
+                try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
+                sidebar = sidebar || 'visible';
+            }
+            html.classList.remove('sidebar-visible');
+            html.classList.add("sidebar-" + sidebar);
+        </script>
+
+        <nav id="sidebar" class="sidebar" aria-label="Table of contents">
+            <div class="sidebar-scrollbox">
+                <ol class="chapter"><li class="chapter-item expanded "><a href="introduction.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="phonology.html"><strong aria-hidden="true">2.</strong> Phonology</a></li><li class="chapter-item expanded "><a href="phonotactics.html"><strong aria-hidden="true">3.</strong> Phonotactics</a></li><li class="chapter-item expanded "><a href="morphology.html"><strong aria-hidden="true">4.</strong> Morphology</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="morphology/contentives.html"><strong aria-hidden="true">4.1.</strong> Contentives</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="morphology/base-slot.html"><strong aria-hidden="true">4.1.1.</strong> Slot #4: Base</a></li><li class="chapter-item expanded "><a href="morphology/extensions-slot.html"><strong aria-hidden="true">4.1.2.</strong> Slot #3: Extensions</a></li><li class="chapter-item expanded "><a href="morphology/role-slot.html"><strong aria-hidden="true">4.1.3.</strong> Slot #2: Role</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="morphology/roles/root-verb-roles.html"><strong aria-hidden="true">4.1.3.1.</strong> Root verb roles</a></li><li class="chapter-item expanded "><a href="morphology/roles/noun-roles.html"><strong aria-hidden="true">4.1.3.2.</strong> Noun roles</a></li><li class="chapter-item expanded "><a href="morphology/roles/subordinators.html"><strong aria-hidden="true">4.1.3.3.</strong> Subordinators</a></li><li class="chapter-item expanded "><a href="morphology/roles/saliency.html"><strong aria-hidden="true">4.1.3.4.</strong> Saliency</a></li><li class="chapter-item expanded "><a href="morphology/roles/determinacy.html"><strong aria-hidden="true">4.1.3.5.</strong> Determinacy</a></li><li class="chapter-item expanded "><a href="morphology/roles/other-case-like-roles.html"><strong aria-hidden="true">4.1.3.6.</strong> Other case-like roles</a></li><li class="chapter-item expanded "><a href="morphology/roles/other-roles.html"><strong aria-hidden="true">4.1.3.7.</strong> Other roles</a></li></ol></li><li class="chapter-item expanded "><a href="morphology/anchoring-slot.html"><strong aria-hidden="true">4.1.4.</strong> Slot #1: Anchoring</a></li></ol></li><li class="chapter-item expanded "><a href="morphology/function-words.html"><strong aria-hidden="true">4.2.</strong> Function words</a></li></ol></li><li class="chapter-item expanded "><a href="syntax.html"><strong aria-hidden="true">5.</strong> Syntax</a></li><li class="chapter-item expanded "><a href="grammemes.html"><strong aria-hidden="true">6.</strong> Grammemes summary</a></li><li class="chapter-item expanded "><a href="lexicon.html"><strong aria-hidden="true">7.</strong> Lexicon</a></li></ol>
+            </div>
+            <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
+        </nav>
+
+        <div id="page-wrapper" class="page-wrapper">
+
+            <div class="page">
+                <div id="menu-bar-hover-placeholder"></div>
+                <div id="menu-bar" class="menu-bar sticky bordered">
+                    <div class="left-buttons">
+                        <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
+                            <i class="fa fa-bars"></i>
+                        </button>
+                        <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
+                            <i class="fa fa-paint-brush"></i>
+                        </button>
+                        <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
+                            <li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
+                        </ul>
+                        <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
+                            <i class="fa fa-search"></i>
+                        </button>
+                    </div>
+
+                    <h1 class="menu-title">Nahaıwa grammar</h1>
+
+                    <div class="right-buttons">
+                        <a href="print.html" title="Print this book" aria-label="Print this book">
+                            <i id="print-button" class="fa fa-print"></i>
+                        </a>
+                    </div>
+                </div>
+
+                <div id="search-wrapper" class="hidden">
+                    <form id="searchbar-outer" class="searchbar-outer">
+                        <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
+                    </form>
+                    <div id="searchresults-outer" class="searchresults-outer hidden">
+                        <div id="searchresults-header" class="searchresults-header"></div>
+                        <ul id="searchresults">
+                        </ul>
+                    </div>
+                </div>
+                <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
+                <script type="text/javascript">
+                    document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
+                    document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
+                    Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
+                        link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
+                    });
+                </script>
+
+                <div id="content" class="content">
+                    <main>
+                        <h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
+<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
+
+                    </main>
+
+                    <nav class="nav-wrapper" aria-label="Page navigation">
+                        <!-- Mobile navigation buttons -->
+                        <div style="clear: both"></div>
+                    </nav>
+                </div>
+            </div>
+
+            <nav class="nav-wide-wrapper" aria-label="Page navigation">
+            </nav>
+
+        </div>
+
+        <script type="text/javascript">
+            window.playground_copyable = true;
+        </script>
+        <script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
+        <script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
+        <script src="searcher.js" type="text/javascript" charset="utf-8"></script>
+        <script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
+        <script src="highlight.js" type="text/javascript" charset="utf-8"></script>
+        <script src="book.js" type="text/javascript" charset="utf-8"></script>
+
+        <!-- Custom JS scripts -->
+    </body>
+</html>
diff --git a/grammar/book/FontAwesome/css/font-awesome.css b/grammar/book/FontAwesome/css/font-awesome.css
diff --git a/grammar/book/FontAwesome/fonts/FontAwesome.ttf b/grammar/book/FontAwesome/fonts/FontAwesome.ttf
diff --git a/grammar/book/FontAwesome/fonts/fontawesome-webfont.eot b/grammar/book/FontAwesome/fonts/fontawesome-webfont.eot