diff options
| author | MegaMech <MegaMech@users.noreply.github.com> | 2024-01-17 10:51:05 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-17 10:51:05 -0700 |
| commit | 7fd1bd2edf3e63a4b3f5f5df3cca324dbc099e37 (patch) | |
| tree | 86b2f425c08e5b2f8d97f4f6a1e25fcb7426a42f | |
| parent | eb69ec24932b39ea4d5e3d6bbb199b64c326a5bf (diff) | |
Add mainpage (#549)
* More work on docs
| -rw-r--r-- | docs/basics/actorsmenu.md | 2 | ||||
| -rw-r--r-- | docs/basics/basicsmenu.md | 4 | ||||
| -rw-r--r-- | docs/basics/courses.md | 3 | ||||
| -rw-r--r-- | docs/basics/coursesmenu.md | 18 | ||||
| -rw-r--r-- | docs/basics/surfacetypes.md | 2 | ||||
| -rw-r--r-- | docs/basics/test.md | 3 | ||||
| -rw-r--r-- | docs/mainpage.md | 144 | ||||
| -rw-r--r-- | docs/tutorials/boostramps.md | 4 | ||||
| -rw-r--r-- | docs/tutorials/tutorials.md | 100 |
9 files changed, 272 insertions, 8 deletions
diff --git a/docs/basics/actorsmenu.md b/docs/basics/actorsmenu.md index afe64e9f0..077269dc1 100644 --- a/docs/basics/actorsmenu.md +++ b/docs/basics/actorsmenu.md @@ -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; diff --git a/docs/basics/basicsmenu.md b/docs/basics/basicsmenu.md index 7bb997471..b216619c1 100644 --- a/docs/basics/basicsmenu.md +++ b/docs/basics/basicsmenu.md @@ -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"> diff --git a/docs/basics/courses.md b/docs/basics/courses.md index f3e9b250b..d34e1af50 100644 --- a/docs/basics/courses.md +++ b/docs/basics/courses.md @@ -1,2 +1,3 @@ \page courses Courses -# Courses
\ No newline at end of file +# Courses + diff --git a/docs/basics/coursesmenu.md b/docs/basics/coursesmenu.md index f111fb33f..c6ec9cfca 100644 --- a/docs/basics/coursesmenu.md +++ b/docs/basics/coursesmenu.md @@ -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 diff --git a/docs/basics/surfacetypes.md b/docs/basics/surfacetypes.md new file mode 100644 index 000000000..202b77c29 --- /dev/null +++ b/docs/basics/surfacetypes.md @@ -0,0 +1,2 @@ +\page surfacetypes Surface Types +# Surface Types diff --git a/docs/basics/test.md b/docs/basics/test.md deleted file mode 100644 index 3daa2fbbd..000000000 --- a/docs/basics/test.md +++ /dev/null @@ -1,3 +0,0 @@ -@page test -# test -sdfsfdds
\ No newline at end of file diff --git a/docs/mainpage.md b/docs/mainpage.md new file mode 100644 index 000000000..48a244771 --- /dev/null +++ b/docs/mainpage.md @@ -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 diff --git a/docs/tutorials/boostramps.md b/docs/tutorials/boostramps.md new file mode 100644 index 000000000..7bbd4b5fe --- /dev/null +++ b/docs/tutorials/boostramps.md @@ -0,0 +1,4 @@ +\page boostramps Boostramps +# Boostramps + +Boostramps use a surface-type and is part of the course geography. diff --git a/docs/tutorials/tutorials.md b/docs/tutorials/tutorials.md new file mode 100644 index 000000000..3ad1cf03b --- /dev/null +++ b/docs/tutorials/tutorials.md @@ -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 |
