Improvements to documentation appearance

A5H73Y · Jan 22, 2020 · f932b2e · f932b2e
1 parent 1c1c78e
commit f932b2e
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 52 deletions.
diff --git a/docs/css/style.css b/docs/css/style.css
@@ -1,7 +1,14 @@
 
 /* Headings */
+h1, .h1 {
+    font-size: 2.3rem;
+}
+
+h2, .h2 {
+    font-size: 2rem;
+}
+
 h1, h2, h3, h4 {
-    font-family: 'Arvo', serif;
     display: block;
     border-bottom: 1px solid #ccc;
     padding-bottom: 5px;

diff --git a/docs/index.html b/docs/index.html
@@ -2,26 +2,23 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <link href="//stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
-    <link href="//fonts.googleapis.com/css?family=Arvo" rel="stylesheet">
-    <link href="css/style.css" rel="stylesheet"/>
+    <link rel="stylesheet" href="//bootswatch.com/4/flatly/bootstrap.min.css">
+    <link rel="stylesheet" href="css/style.css"/>
     <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico" />
     <title>Carz Tutorials</title>
 </head>
-<body>
 
+<body>
 <div class="wrapper">
     <div id="navigation-placeholder"></div>
 
     <section>
         <div class="content">
-            <div class="container">
+            <div class="container-fluid">
                 <div class="row">
                     <div class="col-12">
                         <h1>Carz Tutorials</h1>
-
-                        <p class="no-margin">Hello, and welcome to the new home for Carz Tutorials.</p>
-                        <p>On the left hand side you will find everything there is to know about the Carz plugin. Follow the tutorial in parts to help learn in simple stages, or skip to the step you want to learn.</p>
+                        <p>Welcome! On the left you will find steps covering the various parts of the Carz plugin. If you want to learn everything about the plugin then go through the tutorials step by step, otherwise just skip to the part you are interested in.</p>
 
                         <div class="row">
                             <div class="col-6">
@@ -48,7 +45,7 @@ <h5>Helpful Carz Links</h5>
                                 </div>
                             </div>
                             <div class="col-6">
-                                <h5>My other plugins</h5>
+                                <h5>My Other Plugins</h5>
                                 <div class="list-group">
                                     <a href="https://dev.bukkit.org/projects/parkour" class="list-group-item list-group-item-action">
                                         Parkour
@@ -90,12 +87,9 @@ <h2>Permissions</h2>
             </div>
         </div>
     </section>
-    <footer>
-
-    </footer>
 </div>
 
-<script src="//code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
+<script src="//code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
 <script src="js/script.js"></script>
 </body>
 

diff --git a/docs/part1.html b/docs/part1.html
@@ -2,12 +2,12 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <link href="//stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
-    <link href="//fonts.googleapis.com/css?family=Arvo" rel="stylesheet">
-    <link href="css/style.css" rel="stylesheet"/>
+    <link rel="stylesheet" href="//bootswatch.com/4/flatly/bootstrap.min.css">
+    <link rel="stylesheet" href="css/style.css"/>
     <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico" />
-    <title>Carz Tutorials - Part 1</title>
+    <title>Carz Tutorials</title>
 </head>
+
 <body>
 <div class="wrapper">
     <div id="navigation-placeholder"></div>
@@ -23,8 +23,9 @@ <h1>Part 1 - The Basics</h1>
 
                         <h2 id="aboutCarz">About Carz</h2>
                         <p>Carz was a plugin created to add role-play to my City server. You are able to purchase a Car (Minecart) and lock it to your player, upgrade your car's speed and manage your fuel. Everything is configurable to match the needs of any server.</p>
-                        <p>The plugin is role-play based and can nicely integrate with any Economy compatible plugin, to allow for monetary purchases.</p>
+                        <p>When you become the owner of a Car, no other player will be able to enter / break your car.</p>
                         <p>The players are able to interact with signs instead of commands, to allow for a more immersive experience; for example putting a fuel sign in a Petrol station.</p>
+                        <p>Carz can integrate with any Economy / Vault compatible plugin to allow for monetary purchases.</p>
 
                         <h2 id="commandHelp">Carz Commands</h2>
                         <p>Each individual command can be disabled in the config.yml, to allow for full configuration. The available commands are as follows:</p>
@@ -67,7 +68,7 @@ <h4>/carz reload</h4>
     </section>
 </div>
 
-<script src="//code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
+<script src="//code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
 <script src="js/script.js"></script>
 </body>
 

diff --git a/docs/part2.html b/docs/part2.html
@@ -2,12 +2,12 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <link href="//stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
-    <link href="//fonts.googleapis.com/css?family=Arvo" rel="stylesheet">
-    <link href="css/style.css" rel="stylesheet"/>
+    <link rel="stylesheet" href="//bootswatch.com/4/flatly/bootstrap.min.css">
+    <link rel="stylesheet" href="css/style.css"/>
     <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico" />
-    <title>Carz Tutorials - Part 2</title>
+    <title>Carz Tutorials</title>
 </head>
+
 <body>
 <div class="wrapper">
     <div id="navigation-placeholder"></div>
@@ -21,15 +21,20 @@ <h1>Part 2 - Sign Commands</h1>
 
                         <div id="contents-placeholder"></div>
 
-                        <p>Coming soon.</p>
+                        <h2 id="description">Description</h2>
+                        <p>Command usage can be completely disabled to allow for full emersion of role-play by using signs for every Carz function. This includes: buying a car, upgrading a car, and refueling your car. Ideally you could have a different building for each of these purposes.</p>
+                        <p>If Carz is linked to an Economy plugin, the cost of the purchase will be displayed at the bottom of the sign.</p>
+
+                        <h2 id="purchase">Purchase</h2>
+                        <p>Coming soon...</p>
                     </div>
                 </div>
             </div>
         </div>
     </section>
 </div>
 
-<script src="//code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
+<script src="//code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
 <script src="js/script.js"></script>
 </body>
 

diff --git a/docs/part3.html b/docs/part3.html
@@ -2,12 +2,12 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <link href="//stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
-    <link href="//fonts.googleapis.com/css?family=Arvo" rel="stylesheet">
-    <link href="css/style.css" rel="stylesheet"/>
+    <link rel="stylesheet" href="//bootswatch.com/4/flatly/bootstrap.min.css">
+    <link rel="stylesheet" href="css/style.css"/>
     <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico" />
-    <title>Carz Tutorials - Part 3</title>
+    <title>Carz Tutorials</title>
 </head>
+
 <body>
 <div class="wrapper">
     <div id="navigation-placeholder"></div>
@@ -21,15 +21,16 @@ <h1>Part 3 - Economy</h1>
 
                         <div id="contents-placeholder"></div>
 
-                        <p>Coming soon.</p>
+                        <h2 id="description">Description</h2>
+                        <p>Carz can link to any Economy plugin that uses <a href="vault">Vault</a>. When linked, each Carz function can have an associated cost. These function will be prevented until the player has earned enough money (for example buying a car).</p>
                     </div>
                 </div>
             </div>
         </div>
     </section>
 </div>
 
-<script src="//code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
+<script src="//code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
 <script src="js/script.js"></script>
 </body>
 

diff --git a/docs/part4.html b/docs/part4.html
@@ -2,12 +2,12 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <link href="//stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
-    <link href="//fonts.googleapis.com/css?family=Arvo" rel="stylesheet">
-    <link href="css/style.css" rel="stylesheet"/>
+    <link rel="stylesheet" href="//bootswatch.com/4/flatly/bootstrap.min.css">
+    <link rel="stylesheet" href="css/style.css"/>
     <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico" />
-    <title>Carz Tutorials - Part 4</title>
+    <title>Carz Tutorials</title>
 </head>
+
 <body>
 <div class="wrapper">
     <div id="navigation-placeholder"></div>
@@ -21,15 +21,16 @@ <h1>Part 4 - Configuration</h1>
 
                         <div id="contents-placeholder"></div>
 
-                        <p>Coming soon.</p>
+                        <h2 id="description">Description</h2>
+                        <p></p>
                     </div>
                 </div>
             </div>
         </div>
     </section>
 </div>
 
-<script src="//code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
+<script src="//code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
 <script src="js/script.js"></script>
 </body>
 

diff --git a/docs/part5.html b/docs/part5.html
@@ -2,12 +2,12 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <link href="//stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
-    <link href="//fonts.googleapis.com/css?family=Arvo" rel="stylesheet">
-    <link href="css/style.css" rel="stylesheet"/>
+    <link rel="stylesheet" href="//bootswatch.com/4/flatly/bootstrap.min.css">
+    <link rel="stylesheet" href="css/style.css"/>
     <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico" />
-    <title>Carz Tutorials - Part 5</title>
+    <title>Carz Tutorials</title>
 </head>
+
 <body>
 <div class="wrapper">
     <div id="navigation-placeholder"></div>
@@ -17,19 +17,20 @@
             <div class="container">
                 <div class="row">
                     <div class="col-12">
-                        <h1>Part 5 - Races (coming soon)</h1>
+                        <h1>Part 5 - Races (Coming Soon)</h1>
 
                         <div id="contents-placeholder"></div>
 
-                        <p>Coming soon.</p>
+                        <h2 id="description">Description</h2>
+                        <p></p>
                     </div>
                 </div>
             </div>
         </div>
     </section>
 </div>
 
-<script src="//code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
+<script src="//code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
 <script src="js/script.js"></script>
 </body>
 

diff --git a/docs/part6.html b/docs/part6.html
@@ -2,12 +2,12 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <link href="//stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
-    <link href="//fonts.googleapis.com/css?family=Arvo" rel="stylesheet">
-    <link href="css/style.css" rel="stylesheet"/>
+    <link rel="stylesheet" href="//bootswatch.com/4/flatly/bootstrap.min.css">
+    <link rel="stylesheet" href="css/style.css"/>
     <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico" />
-    <title>Carz Tutorials - Part 6</title>
+    <title>Carz Tutorials</title>
 </head>
+
 <body>
 <div class="wrapper">
     <div id="navigation-placeholder"></div>
@@ -17,19 +17,23 @@
             <div class="container">
                 <div class="row">
                     <div class="col-12">
-                        <h1>Part 6 - Other plugin support</h1>
+                        <h1>Part 6 - Other Plugin Support</h1>
 
                         <div id="contents-placeholder"></div>
 
-                        <p>Coming soon.</p>
+                        <h2 id="description">Description</h2>
+                        <p></p>
+
+                        <h2 id="bountifulAPI">BountifulAPI</h2>
+                        <p>Coming soon...</p>
                     </div>
                 </div>
             </div>
         </div>
     </section>
 </div>
 
-<script src="//code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
+<script src="//code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
 <script src="js/script.js"></script>
 </body>