giant freakin documentation and reorganization pass, it also uses cmake because all the building was getting too complicated for shell scripts
This commit is contained in:
269
res/doc/DoxygenLayout.xml
Normal file
269
res/doc/DoxygenLayout.xml
Normal file
@@ -0,0 +1,269 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<doxygenlayout version="2.0">
|
||||
<!-- Generated by doxygen 1.14.0 -->
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="yes" title=""/>
|
||||
<tab type="pages" visible="yes" title="" intro=""/>
|
||||
<tab type="topics" visible="no" title="" intro=""/>
|
||||
<tab type="modules" visible="yes" title="" intro="">
|
||||
<tab type="modulelist" visible="yes" title="" intro=""/>
|
||||
<tab type="modulemembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="concepts" visible="yes" title="">
|
||||
</tab>
|
||||
<tab type="interfaces" visible="yes" title="">
|
||||
<tab type="interfacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="classes" visible="yes" title="">
|
||||
<tab type="classlist" visible="yes" title="" intro=""/>
|
||||
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="hierarchy" visible="yes" title="" intro=""/>
|
||||
<tab type="classmembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="structs" visible="yes" title="">
|
||||
<tab type="structlist" visible="yes" title="" intro=""/>
|
||||
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
</tab>
|
||||
<tab type="exceptions" visible="yes" title="">
|
||||
<tab type="exceptionlist" visible="yes" title="" intro=""/>
|
||||
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="files" visible="yes" title="">
|
||||
<tab type="filelist" visible="yes" title="" intro=""/>
|
||||
<tab type="globals" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="examples" visible="yes" title="" intro=""/>
|
||||
</navindex>
|
||||
|
||||
<!-- Layout definition for a class page -->
|
||||
<class>
|
||||
<briefdescription visible="yes"/>
|
||||
<detaileddescription visible="yes" title=""/>
|
||||
<includes visible="$SHOW_HEADERFILE"/>
|
||||
<inheritancegraph visible="yes"/>
|
||||
<collaborationgraph visible="yes"/>
|
||||
<memberdecl>
|
||||
<nestedclasses visible="yes" title=""/>
|
||||
<publictypes visible="yes" title=""/>
|
||||
<services visible="yes" title=""/>
|
||||
<interfaces visible="yes" title=""/>
|
||||
<publicslots visible="yes" title=""/>
|
||||
<signals visible="yes" title=""/>
|
||||
<publicmethods visible="yes" title=""/>
|
||||
<publicstaticmethods visible="yes" title=""/>
|
||||
<publicattributes visible="yes" title=""/>
|
||||
<publicstaticattributes visible="yes" title=""/>
|
||||
<protectedtypes visible="yes" title=""/>
|
||||
<protectedslots visible="yes" title=""/>
|
||||
<protectedmethods visible="yes" title=""/>
|
||||
<protectedstaticmethods visible="yes" title=""/>
|
||||
<protectedattributes visible="yes" title=""/>
|
||||
<protectedstaticattributes visible="yes" title=""/>
|
||||
<packagetypes visible="yes" title=""/>
|
||||
<packagemethods visible="yes" title=""/>
|
||||
<packagestaticmethods visible="yes" title=""/>
|
||||
<packageattributes visible="yes" title=""/>
|
||||
<packagestaticattributes visible="yes" title=""/>
|
||||
<properties visible="yes" title=""/>
|
||||
<events visible="yes" title=""/>
|
||||
<privatetypes visible="yes" title=""/>
|
||||
<privateslots visible="yes" title=""/>
|
||||
<privatemethods visible="yes" title=""/>
|
||||
<privatestaticmethods visible="yes" title=""/>
|
||||
<privateattributes visible="yes" title=""/>
|
||||
<privatestaticattributes visible="yes" title=""/>
|
||||
<friends visible="yes" title=""/>
|
||||
<related visible="yes" title="" subtitle=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<memberdef>
|
||||
<inlineclasses visible="yes" title=""/>
|
||||
<typedefs visible="yes" title=""/>
|
||||
<enums visible="yes" title=""/>
|
||||
<services visible="yes" title=""/>
|
||||
<interfaces visible="yes" title=""/>
|
||||
<constructors visible="yes" title=""/>
|
||||
<functions visible="yes" title=""/>
|
||||
<related visible="yes" title=""/>
|
||||
<variables visible="yes" title=""/>
|
||||
<properties visible="yes" title=""/>
|
||||
<events visible="yes" title=""/>
|
||||
</memberdef>
|
||||
<allmemberslink visible="yes"/>
|
||||
<usedfiles visible="$SHOW_USED_FILES"/>
|
||||
<authorsection visible="yes"/>
|
||||
</class>
|
||||
|
||||
<!-- Layout definition for a namespace page -->
|
||||
<namespace>
|
||||
<briefdescription visible="no"/>
|
||||
<detaileddescription visible="yes" title=""/>
|
||||
<memberdecl>
|
||||
<nestednamespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<interfaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<concepts visible="yes" title=""/>
|
||||
<structs visible="yes" title=""/>
|
||||
<exceptions visible="yes" title=""/>
|
||||
<typedefs visible="yes" title=""/>
|
||||
<sequences visible="yes" title=""/>
|
||||
<dictionaries visible="yes" title=""/>
|
||||
<enums visible="yes" title=""/>
|
||||
<functions visible="yes" title=""/>
|
||||
<variables visible="yes" title=""/>
|
||||
<properties visible="yes" title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<memberdef>
|
||||
<inlineclasses visible="yes" title=""/>
|
||||
<typedefs visible="yes" title=""/>
|
||||
<sequences visible="yes" title=""/>
|
||||
<dictionaries visible="yes" title=""/>
|
||||
<enums visible="yes" title=""/>
|
||||
<functions visible="yes" title=""/>
|
||||
<variables visible="yes" title=""/>
|
||||
<properties visible="yes" title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</namespace>
|
||||
|
||||
<!-- Layout definition for a concept page -->
|
||||
<concept>
|
||||
<briefdescription visible="no"/>
|
||||
<detaileddescription visible="yes" title=""/>
|
||||
<includes visible="$SHOW_HEADERFILE"/>
|
||||
<definition visible="yes" title=""/>
|
||||
<authorsection visible="yes"/>
|
||||
</concept>
|
||||
|
||||
<!-- Layout definition for a file page -->
|
||||
<file>
|
||||
<briefdescription visible="no"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<includegraph visible="yes"/>
|
||||
<includedbygraph visible="yes"/>
|
||||
<sourcelink visible="yes"/>
|
||||
<memberdecl>
|
||||
<interfaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<structs visible="yes" title=""/>
|
||||
<exceptions visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<concepts visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<defines visible="yes" title=""/>
|
||||
<typedefs visible="yes" title=""/>
|
||||
<sequences visible="yes" title=""/>
|
||||
<dictionaries visible="yes" title=""/>
|
||||
<enums visible="yes" title=""/>
|
||||
<functions visible="yes" title=""/>
|
||||
<variables visible="yes" title=""/>
|
||||
<properties visible="yes" title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription visible="yes" title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses visible="yes" title=""/>
|
||||
<defines visible="yes" title=""/>
|
||||
<typedefs visible="yes" title=""/>
|
||||
<sequences visible="yes" title=""/>
|
||||
<dictionaries visible="yes" title=""/>
|
||||
<enums visible="yes" title=""/>
|
||||
<functions visible="yes" title=""/>
|
||||
<variables visible="yes" title=""/>
|
||||
<properties visible="yes" title=""/>
|
||||
</memberdef>
|
||||
<authorsection/>
|
||||
</file>
|
||||
|
||||
<!-- Layout definition for a group page -->
|
||||
<group>
|
||||
<briefdescription visible="no"/>
|
||||
<detaileddescription visible="yes" title=""/>
|
||||
<groupgraph visible="yes"/>
|
||||
<memberdecl>
|
||||
<nestedgroups visible="yes" title=""/>
|
||||
<modules visible="yes" title=""/>
|
||||
<dirs visible="yes" title=""/>
|
||||
<files visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<concepts visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<defines visible="yes" title=""/>
|
||||
<typedefs visible="yes" title=""/>
|
||||
<sequences visible="yes" title=""/>
|
||||
<dictionaries visible="yes" title=""/>
|
||||
<enums visible="yes" title=""/>
|
||||
<enumvalues visible="yes" title=""/>
|
||||
<functions visible="yes" title=""/>
|
||||
<variables visible="yes" title=""/>
|
||||
<signals visible="yes" title=""/>
|
||||
<publicslots visible="yes" title=""/>
|
||||
<protectedslots visible="yes" title=""/>
|
||||
<privateslots visible="yes" title=""/>
|
||||
<events visible="yes" title=""/>
|
||||
<properties visible="yes" title=""/>
|
||||
<friends visible="yes" title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<memberdef>
|
||||
<pagedocs/>
|
||||
<inlineclasses visible="yes" title=""/>
|
||||
<defines visible="yes" title=""/>
|
||||
<typedefs visible="yes" title=""/>
|
||||
<sequences visible="yes" title=""/>
|
||||
<dictionaries visible="yes" title=""/>
|
||||
<enums visible="yes" title=""/>
|
||||
<enumvalues visible="yes" title=""/>
|
||||
<functions visible="yes" title=""/>
|
||||
<variables visible="yes" title=""/>
|
||||
<signals visible="yes" title=""/>
|
||||
<publicslots visible="yes" title=""/>
|
||||
<protectedslots visible="yes" title=""/>
|
||||
<privateslots visible="yes" title=""/>
|
||||
<events visible="yes" title=""/>
|
||||
<properties visible="yes" title=""/>
|
||||
<friends visible="yes" title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</group>
|
||||
|
||||
<!-- Layout definition for a C++20 module page -->
|
||||
<module>
|
||||
<briefdescription visible="no"/>
|
||||
<detaileddescription visible="yes" title=""/>
|
||||
<exportedmodules visible="yes"/>
|
||||
<memberdecl>
|
||||
<concepts visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<enums visible="yes" title=""/>
|
||||
<typedefs visible="yes" title=""/>
|
||||
<functions visible="yes" title=""/>
|
||||
<variables visible="yes" title=""/>
|
||||
<membergroups visible="yes" title=""/>
|
||||
</memberdecl>
|
||||
<memberdecl>
|
||||
<files visible="yes"/>
|
||||
</memberdecl>
|
||||
</module>
|
||||
|
||||
<!-- Layout definition for a directory page -->
|
||||
<directory>
|
||||
<briefdescription visible="no"/>
|
||||
<directorygraph visible="yes"/>
|
||||
<memberdecl>
|
||||
<dirs visible="yes"/>
|
||||
<files visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription visible="yes" title=""/>
|
||||
</directory>
|
||||
</doxygenlayout>
|
18
res/doc/footer.html
Normal file
18
res/doc/footer.html
Normal file
@@ -0,0 +1,18 @@
|
||||
<!-- HTML footer for doxygen 1.14.0-->
|
||||
<!-- start footer part -->
|
||||
<!--BEGIN GENERATE_TREEVIEW-->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
$navpath
|
||||
<li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--END GENERATE_TREEVIEW-->
|
||||
<!--BEGIN !GENERATE_TREEVIEW-->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion
|
||||
</small></address>
|
||||
</div><!-- doc-content -->
|
||||
<!--END !GENERATE_TREEVIEW-->
|
||||
</body>
|
||||
</html>
|
76
res/doc/header.html
Normal file
76
res/doc/header.html
Normal file
@@ -0,0 +1,76 @@
|
||||
<!-- HTML header for doxygen 1.14.0-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO" class="light-mode">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen $doxygenversion"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||
<!--BEGIN PROJECT_ICON-->
|
||||
<link rel="icon" href="$relpath^$projecticon" type="image/x-icon" />
|
||||
<!--END PROJECT_ICON-->
|
||||
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<!--BEGIN FULL_SIDEBAR-->
|
||||
<script type="text/javascript">var page_layout=1;</script>
|
||||
<!--END FULL_SIDEBAR-->
|
||||
<script type="text/javascript" src="$relpath^jquery.js"></script>
|
||||
<script type="text/javascript" src="$relpath^dynsections.js"></script>
|
||||
<!--BEGIN COPY_CLIPBOARD-->
|
||||
<script type="text/javascript" src="$relpath^clipboard.js"></script>
|
||||
<!--END COPY_CLIPBOARD-->
|
||||
$treeview
|
||||
$search
|
||||
$mathjax
|
||||
$darkmode
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
</head>
|
||||
<body>
|
||||
<!--BEGIN FULL_SIDEBAR-->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<!--END FULL_SIDEBAR-->
|
||||
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
|
||||
<!--BEGIN TITLEAREA-->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr id="projectrow">
|
||||
<!--BEGIN PROJECT_LOGO-->
|
||||
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"$logosize/></td>
|
||||
<!--END PROJECT_LOGO-->
|
||||
<!--BEGIN PROJECT_NAME-->
|
||||
<td id="projectalign">
|
||||
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber"> $projectnumber</span><!--END PROJECT_NUMBER-->
|
||||
</div>
|
||||
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
|
||||
</td>
|
||||
<!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME-->
|
||||
<!--BEGIN PROJECT_BRIEF-->
|
||||
<td>
|
||||
<div id="projectbrief">$projectbrief</div>
|
||||
</td>
|
||||
<!--END PROJECT_BRIEF-->
|
||||
<!--END !PROJECT_NAME-->
|
||||
<!--BEGIN DISABLE_INDEX-->
|
||||
<!--BEGIN SEARCHENGINE-->
|
||||
<!--BEGIN !FULL_SIDEBAR-->
|
||||
<td>$searchbox</td>
|
||||
<!--END !FULL_SIDEBAR-->
|
||||
<!--END SEARCHENGINE-->
|
||||
<!--END DISABLE_INDEX-->
|
||||
</tr>
|
||||
<!--BEGIN SEARCHENGINE-->
|
||||
<!--BEGIN FULL_SIDEBAR-->
|
||||
<tr><td colspan="2">$searchbox</td></tr>
|
||||
<!--END FULL_SIDEBAR-->
|
||||
<!--END SEARCHENGINE-->
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!--END TITLEAREA-->
|
||||
<!-- end header part -->
|
6
res/doc/index.md
Normal file
6
res/doc/index.md
Normal file
@@ -0,0 +1,6 @@
|
||||
Seagull Game {#mainpage}
|
||||
============
|
||||
|
||||
This is a game about a seagull.
|
||||
|
||||
The rest is up to you.
|
11
res/doc/play/index.md
Normal file
11
res/doc/play/index.md
Normal file
@@ -0,0 +1,11 @@
|
||||
How to Play {#play}
|
||||
===========
|
||||
|
||||
How to play the Seagull Game:
|
||||
* Steal food and shinies.
|
||||
* That's it.
|
||||
|
||||
|
||||
### Subpages
|
||||
* \subpage play-upgrades
|
||||
* \subpage math
|
15
res/doc/play/math.md
Normal file
15
res/doc/play/math.md
Normal file
@@ -0,0 +1,15 @@
|
||||
Mathematical Calculations Used In Game {#math}
|
||||
======================================
|
||||
|
||||
For more information on how dice rolls are calculated, see actions.dice_roll()
|
||||
|
||||
## Calculated Attributes
|
||||
Attribute | Formula
|
||||
----------|--------
|
||||
Speed | \f(\LARGE\(3+(AGL * 1.5)\)\f)
|
||||
|
||||
## Action Success Chances
|
||||
Action | Chance Calculation
|
||||
-------------------|-------------------
|
||||
Stealing resources | \f(\LARGE\((roll+speed)+(\frac{AGL}{4}) \geq 50\)\f)
|
||||
Recruiting | \f(\LARGE\(roll+(LDR*\frac{R_{shinies}}{Colony}) \geq 65\)\f)
|
4
res/doc/play/upgrades.md
Normal file
4
res/doc/play/upgrades.md
Normal file
@@ -0,0 +1,4 @@
|
||||
Upgrades {#play-upgrades}
|
||||
========
|
||||
|
||||
You can buy upgrades in this game!
|
3
res/doc/python/actions.md
Normal file
3
res/doc/python/actions.md
Normal file
@@ -0,0 +1,3 @@
|
||||
\namespace actions
|
||||
\brief Defines game logic functions for in-game actions.
|
||||
|
2
res/doc/python/core.md
Normal file
2
res/doc/python/core.md
Normal file
@@ -0,0 +1,2 @@
|
||||
\namespace core
|
||||
\brief Bare minimum needed for a Seagull-game-like environment.
|
5
res/doc/python/desktop.md
Normal file
5
res/doc/python/desktop.md
Normal file
@@ -0,0 +1,5 @@
|
||||
\namespace desktop
|
||||
\brief Implementation code for desktop specific needs.
|
||||
|
||||
This module also includes a rudimentary "local storage" system within JS_API, since pywebview's local storage APIs
|
||||
seemed non-functional last time I tried to use them.
|
3
res/doc/python/gamedata.md
Normal file
3
res/doc/python/gamedata.md
Normal file
@@ -0,0 +1,3 @@
|
||||
\namespace gamedata
|
||||
\internal
|
||||
\brief Contains everything related to the virtual filesystem.
|
2
res/doc/python/items.generate_item_description.mdpart
Normal file
2
res/doc/python/items.generate_item_description.mdpart
Normal file
@@ -0,0 +1,2 @@
|
||||
This uses <a href="https://rant-lang.org">Rant</a>, a procedural generation language, along with a compiled in
|
||||
wordlist module from a third party wordlist, to generate a unique and occasionally silly item description.
|
9
res/doc/python/items.md
Normal file
9
res/doc/python/items.md
Normal file
@@ -0,0 +1,9 @@
|
||||
\namespace items
|
||||
\brief Game logic related to items and resources.
|
||||
|
||||
This module handles generating of items, each worth a given amount of resources. The values are first calculated
|
||||
according to game rules defined in XML files, then any given modifiers are applied.
|
||||
|
||||
\internal
|
||||
\note This module is almost fully VFS aware.
|
||||
\endinternal
|
2
res/doc/python/tick.md
Normal file
2
res/doc/python/tick.md
Normal file
@@ -0,0 +1,2 @@
|
||||
\namespace tick
|
||||
\brief All logic related to game ticks.
|
2
res/doc/python/upgrades.md
Normal file
2
res/doc/python/upgrades.md
Normal file
@@ -0,0 +1,2 @@
|
||||
\namespace upgrades
|
||||
\brief Upgrade tree related functions.
|
224
res/doc/style.css
Normal file
224
res/doc/style.css
Normal file
@@ -0,0 +1,224 @@
|
||||
html {
|
||||
--primary-color: #17b9c4;
|
||||
--primary-dark-color: #337d80;
|
||||
--primary-light-color: #70d9e9;
|
||||
--on-primary-color: #ffffff;
|
||||
|
||||
/* page base colors */
|
||||
--page-background-color: #ffffff;
|
||||
--page-foreground-color: #2f4153;
|
||||
--page-secondary-foreground-color: #6f7e8e;
|
||||
|
||||
/* color for all separators on the website: hr, borders, ... */
|
||||
--separator-color: #dedede;
|
||||
|
||||
/* border radius for all rounded components. Will affect many components, like dropdowns, memitems, codeblocks, ... */
|
||||
--border-radius-large: 8px;
|
||||
--border-radius-small: 4px;
|
||||
--border-radius-medium: 6px;
|
||||
|
||||
/* default spacings. Most components reference these values for spacing, to provide uniform spacing on the page. */
|
||||
--spacing-small: 5px;
|
||||
--spacing-medium: 10px;
|
||||
--spacing-large: 16px;
|
||||
|
||||
/* default box shadow used for raising an element above the normal content. Used in dropdowns, search result, ... */
|
||||
--box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
|
||||
|
||||
--odd-color: rgba(0,0,0,.028);
|
||||
|
||||
/* font-families. will affect all text on the website
|
||||
* font-family: the normal font for text, headlines, menus
|
||||
* font-family-monospace: used for preformatted text in memtitle, code, fragments
|
||||
*/
|
||||
--font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;
|
||||
--font-family-monospace: ui-monospace,SFMono-Regular,SF Mono,Menlo,Consolas,Liberation Mono,monospace;
|
||||
|
||||
/* font sizes */
|
||||
--page-font-size: 15.6px;
|
||||
--navigation-font-size: 14.4px;
|
||||
--toc-font-size: 13.4px;
|
||||
--code-font-size: 14px; /* affects code, fragment */
|
||||
--title-font-size: 22px;
|
||||
|
||||
/* content text properties. These only affect the page content, not the navigation or any other ui elements */
|
||||
--content-line-height: 27px;
|
||||
/* The content is centered and constraint in it's width. To make the content fill the whole page, set the variable to auto.*/
|
||||
--content-maxwidth: 1050px;
|
||||
--table-line-height: 24px;
|
||||
--toc-sticky-top: var(--spacing-medium);
|
||||
--toc-width: 200px;
|
||||
--toc-max-height: calc(100vh - 2 * var(--spacing-medium) - 85px);
|
||||
|
||||
/* colors for various content boxes: @warning, @note, @deprecated @bug */
|
||||
--warning-color: #faf3d8;
|
||||
--warning-color-dark: #f3a600;
|
||||
--warning-color-darker: #5f4204;
|
||||
--note-color: #e4f3ff;
|
||||
--note-color-dark: #1879C4;
|
||||
--note-color-darker: #274a5c;
|
||||
--todo-color: #e4dafd;
|
||||
--todo-color-dark: #5b2bdd;
|
||||
--todo-color-darker: #2a0d72;
|
||||
--deprecated-color: #ecf0f3;
|
||||
--deprecated-color-dark: #5b6269;
|
||||
--deprecated-color-darker: #43454a;
|
||||
--bug-color: #f8d1cc;
|
||||
--bug-color-dark: #b61825;
|
||||
--bug-color-darker: #75070f;
|
||||
--invariant-color: #d8f1e3;
|
||||
--invariant-color-dark: #44b86f;
|
||||
--invariant-color-darker: #265532;
|
||||
|
||||
/* blockquote colors */
|
||||
--blockquote-background: #f8f9fa;
|
||||
--blockquote-foreground: #636568;
|
||||
|
||||
/* table colors */
|
||||
--tablehead-background: #f1f1f1;
|
||||
--tablehead-foreground: var(--page-foreground-color);
|
||||
|
||||
/* menu-display: block | none
|
||||
* Visibility of the top navigation on screens >= 768px. On smaller screen the menu is always visible.
|
||||
* `GENERATE_TREEVIEW` MUST be enabled!
|
||||
*/
|
||||
--menu-display: block;
|
||||
|
||||
--menu-focus-foreground: var(--on-primary-color);
|
||||
--menu-focus-background: var(--primary-color);
|
||||
--menu-selected-background: rgba(0,0,0,.05);
|
||||
|
||||
|
||||
--header-background: var(--page-background-color);
|
||||
--header-foreground: var(--page-foreground-color);
|
||||
|
||||
/* searchbar colors */
|
||||
--searchbar-background: var(--side-nav-background);
|
||||
--searchbar-foreground: var(--page-foreground-color);
|
||||
|
||||
/* searchbar size
|
||||
* (`searchbar-width` is only applied on screens >= 768px.
|
||||
* on smaller screens the searchbar will always fill the entire screen width) */
|
||||
--searchbar-height: 33px;
|
||||
--searchbar-width: 210px;
|
||||
--searchbar-border-radius: var(--searchbar-height);
|
||||
|
||||
/* code block colors */
|
||||
--code-background: #f5f5f5;
|
||||
--code-foreground: var(--page-foreground-color);
|
||||
|
||||
/* fragment colors */
|
||||
--fragment-background: #F8F9FA;
|
||||
--fragment-foreground: #37474F;
|
||||
--fragment-keyword: #bb6bb2;
|
||||
--fragment-keywordtype: #8258b3;
|
||||
--fragment-keywordflow: #d67c3b;
|
||||
--fragment-token: #438a59;
|
||||
--fragment-comment: #969696;
|
||||
--fragment-link: #5383d6;
|
||||
--fragment-preprocessor: #46aaa5;
|
||||
--fragment-linenumber-color: #797979;
|
||||
--fragment-linenumber-background: #f4f4f5;
|
||||
--fragment-linenumber-border: #e3e5e7;
|
||||
--fragment-lineheight: 20px;
|
||||
|
||||
/* sidebar navigation (treeview) colors */
|
||||
--side-nav-background: #fbfbfb;
|
||||
--side-nav-foreground: var(--page-foreground-color);
|
||||
--side-nav-arrow-opacity: 0;
|
||||
--side-nav-arrow-hover-opacity: 0.9;
|
||||
|
||||
--toc-background: var(--side-nav-background);
|
||||
--toc-foreground: var(--side-nav-foreground);
|
||||
|
||||
/* height of an item in any tree / collapsible table */
|
||||
--tree-item-height: 30px;
|
||||
|
||||
--memname-font-size: var(--code-font-size);
|
||||
--memtitle-font-size: 18px;
|
||||
|
||||
--webkit-scrollbar-size: 7px;
|
||||
--webkit-scrollbar-padding: 4px;
|
||||
--webkit-scrollbar-color: var(--separator-color);
|
||||
|
||||
--animation-duration: .12s
|
||||
}
|
||||
|
||||
span.api-method {
|
||||
padding: 3px;
|
||||
font-weight: bold;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
span.api-method-GET {
|
||||
background-color: #c4eecf;
|
||||
color: #10491f;
|
||||
border: 1px #48d96f dashed;
|
||||
}
|
||||
|
||||
span.api-method-POST {
|
||||
background-color: #eee3c4;
|
||||
color: #493e10;
|
||||
border: 1px #d9bc48 dashed;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
html:not(.light-mode) {
|
||||
color-scheme: dark;
|
||||
|
||||
--primary-color: #19c9d2;
|
||||
--primary-dark-color: #86c0c4;
|
||||
--primary-light-color: #478eac;
|
||||
|
||||
--box-shadow: 0 2px 8px 0 rgba(0,0,0,.35);
|
||||
|
||||
--odd-color: rgba(100,100,100,.06);
|
||||
|
||||
--menu-selected-background: rgba(0,0,0,.4);
|
||||
|
||||
--page-background-color: #1C1D1F;
|
||||
--page-foreground-color: #d2dbde;
|
||||
--page-secondary-foreground-color: #859399;
|
||||
--separator-color: #38393b;
|
||||
--side-nav-background: #252628;
|
||||
|
||||
--code-background: #2a2c2f;
|
||||
|
||||
--tablehead-background: #2a2c2f;
|
||||
|
||||
--blockquote-background: #222325;
|
||||
--blockquote-foreground: #7e8c92;
|
||||
|
||||
--warning-color: #3b2e04;
|
||||
--warning-color-dark: #f1b602;
|
||||
--warning-color-darker: #ceb670;
|
||||
--note-color: #163750;
|
||||
--note-color-dark: #1982D2;
|
||||
--note-color-darker: #dcf0fa;
|
||||
--todo-color: #2a2536;
|
||||
--todo-color-dark: #7661b3;
|
||||
--todo-color-darker: #ae9ed6;
|
||||
--deprecated-color: #2e323b;
|
||||
--deprecated-color-dark: #738396;
|
||||
--deprecated-color-darker: #abb0bd;
|
||||
--bug-color: #2e1917;
|
||||
--bug-color-dark: #ad2617;
|
||||
--bug-color-darker: #f5b1aa;
|
||||
--invariant-color: #303a35;
|
||||
--invariant-color-dark: #76ce96;
|
||||
--invariant-color-darker: #cceed5;
|
||||
|
||||
--fragment-background: #282c34;
|
||||
--fragment-foreground: #dbe4eb;
|
||||
--fragment-keyword: #cc99cd;
|
||||
--fragment-keywordtype: #ab99cd;
|
||||
--fragment-keywordflow: #e08000;
|
||||
--fragment-token: #7ec699;
|
||||
--fragment-comment: #999999;
|
||||
--fragment-link: #98c0e3;
|
||||
--fragment-preprocessor: #65cabe;
|
||||
--fragment-linenumber-color: #cccccc;
|
||||
--fragment-linenumber-background: #35393c;
|
||||
--fragment-linenumber-border: #1f1f1f;
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user