Add mainpage (#549)

* More work on docs
This commit is contained in:
MegaMech 2024-01-17 10:51:05 -07:00 committed by GitHub
parent eb69ec2493
commit 7fd1bd2edf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 272 additions and 8 deletions

View File

@ -19,7 +19,7 @@ thwomps, bowser fire-breath, moles, hedgehogs, snowmen, crabs, etc (also, probab
The object system is much more complex than actors and is not well documented.
\htmlonly
<br>
<style>
.pagebutton {
display: inline-block;

View File

@ -3,7 +3,7 @@
\htmlonly
Essential skills and concepts to help you get started with mk64 decomp.
<br>
<style>
.pagebutton {
display: inline-block;
@ -116,7 +116,7 @@ p {
<p>Become familiar with technical and low-level concepts.</p>
<div class="pagebutton">
<a class="pagea" href="basicconcepts.html">
<a class="pagea" href="concepts.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">

View File

@ -1,2 +1,3 @@
\page courses Courses
# Courses
# Courses

View File

@ -3,7 +3,7 @@
\htmlonly
How courses work in mk64
<br>
<style>
.pagebutton {
display: inline-block;
@ -98,7 +98,23 @@ p {
</a>
</div>
<div class="pagebutton">
<a class="pagea" href="surfacetypes.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Surface Types</div>
<div class="pagedescription">
<p>Surface types in mk64</p>
</div>
</div>
</div>
</a>
</div>
\endhtmlonly
\subpage courses
\subpage surfacetypes

View File

@ -0,0 +1,2 @@
\page surfacetypes Surface Types
# Surface Types

View File

@ -1,3 +0,0 @@
@page test
# test
sdfsfdds

144
docs/mainpage.md Normal file
View File

@ -0,0 +1,144 @@
\mainpage mk64 API
Complete resources for learning about mk64 decomp
\htmlonly
Essential skills and concepts to help you get started with mk64 decomp.
<br>
<style>
.pagebutton {
display: inline-block;
margin-right: 1em;
margin-bottom: 1em;
}
.pagelink {
display: block;
background-color: rgb(40, 44, 52);
width: 320px;
box-shadow: 0 0 0 0;
transition: 0.3s ease;
}
.pagelink:hover {
box-shadow: 0 5px 15px 5px rgba(0,0,0,1);
}
.pagelink:hover img {
transform: scale3d(1.1,1.1,1.1);
}
.pageimg {
display: inline-block;
width: 100%;
position: relative;
overflow: hidden;
}
.pageimg img {
transition: 0.3s ease;
}
.content {
color: white;
font-size: 1em;
padding: 0;
margin: 0;
}
.pageheading {
padding: .5em .5em;
font-size: 18px;
color: white;
font-weight: bold;
text-decoration: none;
}
.pagedescription {
color: #fff;
border-color: transparent;
opacity: 0.75;
height: 84px;
text-overflow: ellipsis;
overflow: hidden;
margin-top: 10px;
display: block;
padding: 10px;
text-decoration: none;
line-height: 1.64em;
font-size: 1em;
font-weight: normal;
text-decoration: none;
}
.pagea {
display: inline-block;
}
.pagea:link {
text-decoration: none;
}
.pagea:visited {
text-decoration: none;
}
.pagea:hover {
text-decoration: none;
}
.pagea:active {
text-decoration: none;
}
p {
margin: 0;
padding: 0;
}
</style>
<div class="pagebutton">
<a class="pagea" href="basicsmenu.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Understanding the Basics</div>
<div class="pagedescription">
<p>Essential skills and concepts to help you get started with mk64 decomp</p>
</div>
</div>
</div>
</a>
</div>
<div class="pagebutton">
<a class="pagea" href="actorsmenu.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Actors</div>
<div class="pagedescription">
<p>Learn the inns and outs of mk64's actors, items, vehicles, and behaviour code</p>
</div>
</div>
</div>
</a>
</div>
<div class="pagebutton">
<a class="pagea" href="coursesmenu.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Courses</div>
<div class="pagedescription">
<p>Learn how mk64's courses are constructed</p>
</div>
</div>
</div>
</a>
</div>
<div class="pagebutton">
<a class="pagea" href="tutorials.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Tutorials</div>
<div class="pagedescription">
<p>Topics tailored to specific issues such as boostramps.</p>
</div>
</div>
</div>
</a>
</div>
\endhtmlonly

View File

@ -0,0 +1,4 @@
\page boostramps Boostramps
# Boostramps
Boostramps use a surface-type and is part of the course geography.

100
docs/tutorials/tutorials.md Normal file
View File

@ -0,0 +1,100 @@
\page tutorials Tutorials
# Tutorials
\htmlonly
<style>
.pagebutton {
display: inline-block;
margin-right: 1em;
margin-bottom: 1em;
}
.pagelink {
display: block;
background-color: rgb(40, 44, 52);
width: 320px;
box-shadow: 0 0 0 0;
transition: 0.3s ease;
}
.pagelink:hover {
box-shadow: 0 5px 15px 5px rgba(0,0,0,1);
}
.pagelink:hover img {
transform: scale3d(1.1,1.1,1.1);
}
.pageimg {
display: inline-block;
width: 100%;
position: relative;
overflow: hidden;
}
.pageimg img {
transition: 0.3s ease;
}
.content {
color: white;
font-size: 1em;
padding: 0;
margin: 0;
}
.pageheading {
padding: .5em .5em;
font-size: 18px;
color: white;
font-weight: bold;
text-decoration: none;
}
.pagedescription {
color: #fff;
border-color: transparent;
opacity: 0.75;
height: 84px;
text-overflow: ellipsis;
overflow: hidden;
margin-top: 10px;
display: block;
padding: 10px;
text-decoration: none;
line-height: 1.64em;
font-size: 1em;
font-weight: normal;
text-decoration: none;
}
.pagea {
display: inline-block;
}
.pagea:link {
text-decoration: none;
}
.pagea:visited {
text-decoration: none;
}
.pagea:hover {
text-decoration: none;
}
.pagea:active {
text-decoration: none;
}
p {
margin: 0;
padding: 0;
}
</style>
<div class="pagebutton">
<a class="pagea" href="boostramps.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
<div class="content">
<div class="pageheading">Boostramps</div>
<div class="pagedescription">
<p>Steps for creating your own boostramps</p>
</div>
</div>
</div>
</a>
</div>
\endhtmlonly
\subpage boostramps