example-lurch-site/index.html at main · lurchmath/example-lurch-site · GitHub

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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<!DOCTYPE html>
<html>
    <head>
        <title>Example Lurch Site Landing Page</title>
        <link
            rel="stylesheet"
            href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css"
            integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
            crossorigin="anonymous"
        />
        <meta name="viewport" content="width=device-width, initial-scale=1"/>
    </head>
    <body style="padding-top: 1em">
        <div class="container">
            <h1 class="alert alert-dark">Example Lurch Site Landing Page</h1>
            <h3 class="alert alert-primary">What's a Lurch Site?</h3>
            <p><a href="http://lurchmath.github.io/site/what-is-a-lurch-site"
                >Read the answer here.</a>  This Lurch Site is an example to
                help you learn how to create your own.</p>
            <h3 class="alert alert-primary">What is this page?</h3>
            <p>This is a simple landing page to show you how to create a landing
                page in your Lurch Site.  Feel free to copy it
                (<a href="https://github.com/lurchmath/example-lurch-site/blob/main/index.html">code</a>)
                as a starting point.</p>
            <p>To add such a page to your site, just place any
                <code>.html</code> file in the root folder of your Lurch Site
                repository.  The page that loads by default when a user visits
                your site is <code>index.html</code>, like this one.  But you
                can create multiple pages with links among them if you need.</p>
            <!-- If you copy this site, modify the URL above to contain your
                    GitHub username and repository name. -->
            <p>For more information on what's possible with GitHub web hosting,
                <a href="https://docs.github.com/en/pages">see here</a>.</p>
            <h3 class="alert alert-primary">What should my pages say?</h3>
            <p>Anything you like!  We suggest three things.</p>
            <p><div class="card">
                <div class="card-body">
                    <h5 class="card-title">1. Describe your Lurch Site</h5>
                    <p class="card-text">Which course or audience it is
                        designed for?  Who is the instructor?</p>
                    <p>How much of this you include and in what style is totally
                        up to you.</p>
                </div>
            </div></p>
            <p><div class="card">
                <div class="card-body">
                    <h5 class="card-title">2. Link to the app</h5>
                    <p class="card-text">Provide a link to the copy of the Lurch
                        app that's hosted within the site.  See the URLs used
                        below as examples.</p>
                    <div class="row">
                        <div class="col">
                            <p><a href="./app/" style="width: 100%"
                                class="btn btn-primary">App in default mode for instructors</a></p>
                        </div>
                        <div class="col">
                            <p><a href="./app/?config=default-student" style="width: 100%"
                                class="btn btn-primary">App in default mode for students</a></p>
                        </div>
                    </div>
                    <div class="row">
                        <div class="col">
                            <p><a href="./app/?config=minimal-instructor" style="width: 100%"
                                class="btn btn-primary">App in minimal mode for instructors</a></p>
                        </div>
                        <div class="col">
                            <p><a href="./app/?config=minimal-student" style="width: 100%"
                                class="btn btn-primary">App in minimal mode for students</a></p>
                        </div>
                    </div>
                    <p>The links above use the <code>config</code> query
                        parameter.  To learn more about what that means, see
                        <a href="https://github.com/lurchmath/example-lurch-site/blob/main/config/README.md">
                        the README file</a> in this example repository's
                        configuration folder.</p>
                </div>
            </div></p>
            <p><div class="card">
                <div class="card-body">
                    <h5 class="card-title">3. Link to your documents</h5>
                    <p class="card-text">Provide links to open one or more of
                        the mathematical documents within the site, opening them
                        in the copy of the Lurch app that's hosted within the
                        site.</p>
                    <p>We suggest putting such files in
                        <a href="https://github.com/lurchmath/example-lurch-site/blob/main/math/"
                        >the <code>/math</code> folder</a> that's already been
                        created in this site for that purpose.  If you do so,
                        then links to your file look like the examples below.</p>
                    <!-- If you copy this site, modify the URL above to contain
                         your GitHub username and repository name. -->
                    <div class="row">
                        <div class="col">
                            <p><a href="./app/?load=../math/PropositionalLogic.lurch" style="width: 100%"
                                class="btn btn-primary">Rules for propositional logic</a></p>
                        </div>
                        <div class="col">
                            <p><a href="./app/?load=../math/PropositionalProofs.lurch" style="width: 100%"
                                class="btn btn-primary">A few uses of those rules in a proof</a></p>
                        </div>
                    </div>
                    <p>The links above use the <code>load</code> query
                        parameter.  You can use that parameter together with
                        the <code>config</code> parameter mentioned earlier,
                        as in <nobr><code>?config=X&amp;load=Y</code></nobr>.</p>
                </div>
            </div></p>
        </div>
        <script
            src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
            integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
            crossorigin="anonymous">
        </script>
    </body>
</html>