Azurite-Docs/index.html at main · azurite-engine/Azurite-Docs · 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
<!DOCTYPE html>
<html>

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Azurite Documentation</title>
    <link href="css/style.css" rel="stylesheet" type="text/css">
    <script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
    <script src="js/getBaseURL.js"></script>
</head>

<body>
    <!-- Insert the top navigation bar and welcome header -->
    <script src="js/insert/navbar.js"></script>
    <!-- Insert the top navigation bar and welcome header -->
    <script type="text/javascript" src="js/insert/header.js"></script>

    <script>
        // Change these to the title of the documentation topic/item
        setHeader("Welcome to the Azurite Docs!", "Select a topic to view its documentation.");
    </script>

    <!-- Documentation -->
    <div class="documentation">
        <div class="container grid contentparent" id="docs">
            <!-- Documentation Legend -->
            <div class="legend-card"></div>

            <!-- Documentation Content -->
            <div class="card">
                <h3>Introduction</h3>
                <p>Welcome to the Azurite Engine docs. Azurite is a community built Java game engine. Built from the ground up on top of LWJGL, it is cross platform (PC), fast, and easy to use.</p>

                <h3>How to read the docs</h3>
                <p>The docs are seperated into technical documentation pages, covering individual classes and methods available in the engine, and a <a href="tutorials-main.html">tutorials section</a>, which focuses on teaching how to use specific systems.</p>

                <p>Throughout the documentation, you may see elements similar to the following:</p>
                <div class="danger">A danger tag warns that an action may cause serious problems.</div>
                <div class="warn">A warning tag indicates that caution should be used.</div>
                <div class="info">An Information tag communicates important information that may otherwise be overlooked.</div>
                <a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" class="button">Button</a>

                <p>Lorem ipsum dolor sit amet consectetur adipisicing elit.Totam eligendi molestias voluptas error harum alias repellendus fugiat consequatur sapiente quidem atque aperiam architecto distinctio cumque animi nesciunt, corporis consequuntur
                    ea eius iste perspiciatis! Suscipit est vitae ea obcaecati <code>Code snippet inside paragraph</code> et reiciendis excepturi earum itaque deleniti inventore. Laboriosam consequuntur recusandae nisi numquam.</p>

                <!-- Multi line code -->
                <pre class="syntax-java">
public static void main(String[] args) {
    // This is a multiline code snippet
    System.out.println("Hello World!");
}
                </pre>

                <p>You will see in tables some important data e.g. method variants.</p>
                <table>
                    <tr>
                        <th>Table Header</th><th>Table Header 2</th>
                    </tr>
                    <tr>
                        <td>Row 1 Column 1</td><td>Row 1 Column 2</td>
                    </tr>
                    <tr>
                        <td>Row 2 Column 1</td><td>Row 2 Column 2</td>
                    </tr>
                </table>


                <h3>Contributing</h3>
                <p>If you are interested in contributing to the engine, check out the <a href="https://games-with-gabe-community.github.io/azurite-javadocs/" target="_blank">Javadocs</a> and <a href="https://github.com/Games-With-Gabe-Community/Azurite"
                        target="_blank">Github Repository</a>. We highly recommend joining the <a href="https://discord.com/invite/dhyV3BXkRZ" target="_blank">Discord</a> so that you can quickly get help and feedback from the community.</p>
            </div>
        </div>
    </div>

    <!-- Insert the navigation legend and footer -->
    <script src="js/insert/legendDocs.js"></script>
    <script src="js/insert/footer.js"></script>

    <script src="js/syntaxHighlighting.js"></script>
</body>

</html>