Initial Commit

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization 
+* text=auto

.gitignore

@@ -0,0 +1 @@
+site/

README.md

@@ -1,2 +1,15 @@
-# Tabletop-Simulator-Documentation
-Documentation for the use of Tabletop Simulator
+# Tabletop Simulator API
+
+This is the source of the api documentation in Tabletop Simulator. It uses a modified version of [Material-Design](https://github.com/squidfunk/mkdocs-material) for MKDocs.
+
+## How it Works
+
+The `.md` files in the `/docs` folder are written in Markdown, which is an easy-to-use markup language to add formatting to text. Additionally, some custom CSS is used, as well as a handful of custom images. When making changes, it is possible to live-preview them as you go if you have set up the local files for mkdocs + material design.
+
+Alternatively, you can make modifications to individual pages then submit them for review. The developers will always be the ones to build and publish the site anyway, all you will do is modify the contents of this Git.
+
+### Installing
+
+If you choose to install MKDocs so you can live-preview your changes, you may do so [by following these instructions](https://squidfunk.github.io/mkdocs-material/getting-started/).
+
+Otherwise, you will not need to install anything to edit the text files.

deploy.bat

@@ -0,0 +1 @@
+mkdocs gh-deploy

docs/css/i_icons.css

@@ -0,0 +1,10 @@
+/*Styling the i icons that link to details*/
+
+.i:after {
+    font-family: "Material Icons";
+    content: "\E88F";
+    font-size: 22px;
+
+    position: relative;
+    right: 2px;
+}

docs/css/player_color_table.css

@@ -0,0 +1,30 @@
+/*Formatting for Player Color page's table*/
+
+table.playerColorTable {
+  width: 100%;
+  text-align: center;
+  border-collapse: collapse;
+  border-color: grey;
+  border-spacing: 1px;
+  border-radius: .2rem;
+  box-shadow: 0 2px 2px 0 rgba(0,0,0,.14), 0 1px 5px 0 rgba(0,0,0,.12), 0 3px 1px -2px rgba(0,0,0,.2);
+}
+table.playerColorTable td {
+  padding: 6px 2px;
+}
+table.playerColorTable tr:nth-child(even) {
+  background: #E8E8E8;
+}
+table.playerColorTable thead th {
+  font-size: 15px;
+  font-weight: bold;
+  color: #FFFFFF;
+  background-color: rgba(0,0,0,.54);
+  text-align: center;
+}
+table.playerColorTable td {
+    vertical-align: middle;
+}
+table.playerColorTable th {
+    padding: 16px 2px;
+}

docs/css/table.css

@@ -0,0 +1,32 @@
+/*General table formatting of markdown-created tables*/
+
+/*Table Striping*/
+.md-typeset__table table tr:nth-child(even) {
+    background-color: #f2f2f2;
+}
+
+/*Table padding*/
+.md-typeset table:not([class]) td {
+    padding: 4px 6px;
+    vertical-align: middle;
+}
+.md-typeset table:not([class]) th {
+    min-width: 0px;
+    padding: 14px 6px;
+}
+
+/*Prevent break of function name in table*/
+.md-typeset table th:first-child {
+    white-space: nowrap;
+}
+
+/*Prevent break of function name in table*/
+.md-typeset table td:first-child {
+    font-family: 'Inconsolata', 'Monaco', 'Consolas', 'Courier New', 'Courier';
+}
+
+
+/*Nowrap on first row of tables
+html body div.md-container table tr td:first-child {
+    white-space: nowrap;
+}*/

docs/css/theme.css

@@ -0,0 +1,102 @@
+/*Changing icon for permalinks*/
+.headerlink:after {
+    font-family: "Material Icons";
+    content: "\E157";
+}
+.headerlink {
+    font-family: "Helvetica Neue,Helvetica,Arial,sans-serif";
+}
+
+
+/*Disable top bar shdow fade-in*/
+.md-header {
+    transition: initial !important;
+}
+
+/*Increase width/height of icon on top bar*/
+.md-header-nav__button.md-logo * {
+    width: 42px;
+    height: 42px;
+    position: relative;
+    bottom: 5px;
+}
+
+/*background behind current selection in left bar*/
+[data-md-color-primary=indigo] .md-nav__link--active, [data-md-color-primary=indigo] .md-nav__link:active {
+    color: black;
+    background-color: #d3d3d3;
+    padding: 2px;
+}
+
+/*Coloring of top bar*/
+[data-md-color-primary=indigo] .md-header, [data-md-color-primary=indigo] .md-hero {
+  background-color: #bb0c0d;
+}
+
+/*Header coloring and formatting*/
+.md-typeset h1 {
+    color: #000000;
+    font-weight: 600;
+    font-size: 3.2rem;
+    text-transform: none;
+    font-family: "Roboto","Helvetica Neue",Helvetica,Arial,sans-serif;
+}
+.md-typeset h2{
+    color: #202020;
+    font-weight: 500;
+    font-size: 2.9rem;
+    text-transform: none;
+    font-family: "Roboto","Helvetica Neue",Helvetica,Arial,sans-serif;
+}
+.md-typeset h3 {
+    color: #404040;
+    font-weight: 500;
+    font-size: 2.6rem;
+    text-transform: none;
+    font-family: "Roboto","Helvetica Neue",Helvetica,Arial,sans-serif;
+}
+.md-typeset h4 {
+    color: #606060;
+    font-weight: 400;
+    font-size: 2.3rem;
+    text-transform: none;
+    font-family: "Roboto","Helvetica Neue",Helvetica,Arial,sans-serif;
+}
+.md-typeset h5 {
+    color: #808080;
+    font-weight: 300;
+    font-size: 2rem;
+    text-transform: none;
+    font-family: "Roboto","Helvetica Neue",Helvetica,Arial,sans-serif;
+}
+.md-typeset h6 {
+    color: #A0A0A0;
+    font-weight: 200;
+    font-size: 1.7rem;
+    text-transform: none;
+    font-family: "Roboto","Helvetica Neue",Helvetica,Arial,sans-serif;
+}
+
+/*Coloring of permalink icon*/
+[data-md-color-accent=indigo] .md-nav__link:focus, [data-md-color-accent=indigo] .md-nav__link:hover, [data-md-color-accent=indigo] .md-typeset .footnote li:hover .footnote-backref:hover, [data-md-color-accent=indigo] .md-typeset .footnote li:target .footnote-backref, [data-md-color-accent=indigo] .md-typeset .md-clipboard:active:before, [data-md-color-accent=indigo] .md-typeset .md-clipboard:hover:before, [data-md-color-accent=indigo] .md-typeset [id] .headerlink:focus, [data-md-color-accent=indigo] .md-typeset [id]:hover .headerlink:hover, [data-md-color-accent=indigo] .md-typeset [id]:target .headerlink {
+    color: #8b090a;
+}
+
+/*Make edit button red, !important required*/
+.md-content__icon {
+    color: #bb0c0d !important; 
+}
+
+/*anchor offset*/
+.anchor:before {
+    content:"";
+    display:block;
+    height:130px; /* fixed header height*/
+    margin:-130px 0 0; /* negative fixed header height */
+}
+
+/*prevent left/right scrollbar
+.md-typeset .admonition, .md-typeset details {
+    overflow-x:hidden;
+}
+disabled due to lack of need currently, but works*/

docs/css/type_icons.css

@@ -0,0 +1,176 @@
+/*General Icon Formatting, used by all tag type icons*/
+.tag {
+    font-family: 'Inconsolata', 'Monaco', 'Consolas', 'Courier New', 'Courier';
+    font-weight: normal;
+    text-align: center;
+    font-size: 1rem;
+    display: inline;
+    padding: 2px 4px;
+    border-radius:5px;
+    position: relative;
+    margin: 0px 1px;
+
+    word-break: normal;
+
+    width: 50px;
+    min_width: 50px;
+    line-height: 0;
+}
+.tag:hover {
+    opacity: 0.75;
+}
+
+/*General Return Formatting, used by all return type icons*/
+.ret {
+    font-family: 'Inconsolata', 'Monaco', 'Consolas', 'Courier New', 'Courier';
+    /*background-color:rgba(1, 0, 0, 0.2);*/
+    font-style: italic;
+    text-align: center;
+    font-size: 1rem;
+    /*padding: 1px 4px;
+    box-shadow: 2px 2px #696969;
+    border-radius: 6px;*/
+    border-radius:5px;
+    padding: 2px 4px;
+    display: inline-block;
+
+    position: relative;
+    bottom: 1px;
+    left: 1px;
+    vertical-align:middle;
+
+    float: left;
+    width: 50px;
+    /*Squeezes lines together vertically*/
+    line-height: 1;
+
+    word-break: keep-all;
+}
+.ret:hover {
+    opacity: 0.75;
+}
+.ret:before {
+    content: "return\A";
+}
+
+
+
+
+/*String*/
+.str {
+    color: #000000;
+    background-color: #ACC39B;
+}
+.str:after {
+    content: "string";
+}
+
+/*Table*/
+.tab {
+    color: #000000;
+    background-color: rgba(1, 0, 0, 0.2);
+}
+.tab:after {
+    content: "table";
+}
+
+/*Integer*/
+.int {
+    color: #000000;
+    background-color: #D48E87;
+}
+.int:after {
+    content: "int";
+}
+
+/*Float*/
+.flo {
+    color: #000000;
+    background-color: #D48E87;
+}
+.flo:after {
+    content: "float";
+}
+
+/*Nil*/
+.nil {
+    color: #ffffff;
+    background-color: rgba(1, 0, 0, 0.6);
+}
+.nil:after {
+    content: "nil";
+}
+
+/*Bool*/
+.boo {
+    color: #000000;
+    background-color: #BE9FAD;
+}
+.boo:after {
+    content: "bool";
+}
+
+/*Object*/
+.obj {
+    color: #000000;
+    background-color: #b1bfe0;
+}
+.obj:after {
+    content: "object";
+}
+
+/*Var*/
+.var {
+    color: #000000;
+    background-color: #E0E270;
+}
+.var:after {
+    content: "var";
+}
+
+/*Vector*/
+.vec {
+    color: #000000;
+    background-color: #f4d29a;
+}
+.vec:after {
+    content: "vector";
+}
+
+/*Color*/
+.col {
+    color: #000000;
+    background-color: #e2bae0;
+}
+.col:after {
+    content: "color";
+}
+
+/*Player*/
+.pla {
+    color: #000000;
+    background-color: #b5e1e5;
+}
+.pla:after {
+    content: "player";
+}
+
+/*XML stuff*/
+
+/*xmlcolor*/
+.xmlco {
+    color: #000000;
+    background-color: #B87FED;
+}
+.xmlco:after {
+    content: "color";
+}
+
+/*xmlcolorblock*/
+.xmlcb {
+    color: #000000;
+    background-color: #ed7feb;
+}
+.xmlcb:after {
+    content: "colorblock";
+}