docket 0.7.1

Simple markdown to HTML documentation rendering
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

// # Javascript Progressive Search for Docket
//
// This file loads a search index that's pre-baked by `docket` at documentation
// compile time. If the search index loads we inject the search box into the
// page and enable the search.

const initialiseSearch = async (rootPath, targetSelector) => {
    const searchForm = document.querySelector(targetSelector);
    if (searchForm == null) {
        return;
    }

    searchForm.innerHTML = `<h2>Search</h2>
    <form target="none">
        <input id="query" autofocus="" placeholder="enter your search" type="search">
        <button action="submit">Search</button>
    </form>
    <div id="docket-search-results"></div>`;
    const searchBox = searchForm.querySelector('#query');
    const searchResults = searchForm.querySelector('#docket-search-results');

    const searchEntryForResult = result => {
        return `<li><a class="search-result" href="${rootPath}${result.slug}/" >${result.title}</a></li>`;
    }

    const displayResults = results => {
        if (results.length == 0) {
            searchResults.innerHTML = "<h3>No results</h3>";
        } else {
            searchResults.innerHTML =
                `<h3>${results.length} results</h3>
                <ul class="search-results">
                    ${results.map(searchEntryForResult).join('')}
                </ul>`;
        }
    }

    const searchIndex = await fetch(`${rootPath}search_index.json`)
        .then(response => response.json());

    const doSearch = query => {

        // If the search is empty clean up.
        if (query.trim().length == 0) {
            searchResults.innerHTML = "";
            return;
        }

        let terms = query.split(/\W+/)
            .map(term => term.trim().toLowerCase())
            .filter(term => term.length > 0);
        let found = []

        searchIndex.forEach(page => {
            let score = 0;
            terms.forEach(term => {
                let termScore = page.terms[term];
                if (termScore !== undefined) {
                    score += termScore;
                }
            });
            if (score > 0) {
                found.push({
                    score: score,
                    page: page,
                });
            }
        });

        // Order them by the score, descending.
        found.sort((a, b) => b.score - a.score);

        displayResults(found.map(f => f.page));
    }

    let timer = null;
    searchBox.addEventListener('keyup', event => {
        if (timer !== null) {
            clearTimeout(timer);
        }
        timer = setTimeout(() => {
            timer = null;
            doSearch(searchBox.value);
        }, 500);
    });

    searchForm.addEventListener('submit', event => {
        event.preventDefault();
        if (timer !== null) {
            clearTimeout(timer);
            timer = null;
        }
        doSearch(searchBox.value);
    });
}

const uri = import.meta.url;
initialiseSearch(uri.substring(0, uri.lastIndexOf('/') + 1), '#docket-search')