docs: Main docs update (#1304)
* Remove template in favor of official samples * Fixed a variable name copy pasta mistake line 35 was _database.GetData() instead of DBService.GetData() * Experimental theme change * Change paragraph, code, heading fonts * Widen viewport * Update DocFX.Plugins.LastModified v1.2.3 * Exclude Discord.API in docs * Add remarks for SocketReaction properties * Add examples for BaseSocketClient.Events * Add additional clarification for some methods * Move IUser and IGuildChannel examples * Clarify several guides samples with notes - Reword TypeReader comment to avoid giving the idea that the sample itself is "obsolete" - Remove CommandException logging comment regarding C#7.0 as the version is now the standard across VS2017 and up - Remove suggestion about handling result in command handler since it is now advised to use CommandExecuted instead + Add additional comment to clarify ctor for DI setup * Add/migrate code examples * Incorporate material design theme License @ https://github.com/ovasquez * Update installation and nightly guide * Fix improper indentations made obvious by the widen viewport * Fix minor grammar issues + Add installation for nightly build using dotnet CLI * Fix nav level indentation * Revise "Your First Bot" article * Merge some paragraphs to avoid clutter while keeping readability * Reword the use of command framework + Add additional warning/note about environment variable * Add additional indent level * Fix indentation text warping * Remove connections sample * Update logging sample Remove redundant part of the sample * Remove mention of RPC * Remove misleading section about commands - Remove command sample from complete snippet * Revise "Your First Bot" command paragraphs * Change wording to hint devs that additional command parser packages may be available, as more and more begin to crop up * Update themes * Add XML docs contribution guidelines Update guidelines * Update CommandExecuted remarks * Fix precondition remarks typo no one saw that ok * Fix permission sample in docfx * Fix IMessageChannel samples * Update docs/_template/light-dark-theme/styles/docfx.vendor.minify.css Co-Authored-By: Still34 <341464@gmail.com> * Update docs/_template/light-dark-theme/styles/material.css Co-Authored-By: Still34 <341464@gmail.com> * Update docs/_template/light-dark-theme/styles/material.css Co-Authored-By: Still34 <341464@gmail.com>
This commit is contained in:
Binary file not shown.
Binary file not shown.
@@ -1,4 +1,4 @@
|
||||
<configuration>
|
||||
<dllmap os="linux" cpu="x86-64" wordsize="64" dll="git2-8e0b172" target="lib/linux-x64/libgit2-8e0b172.so" />
|
||||
<dllmap os="osx" cpu="x86,x86-64" dll="git2-8e0b172" target="lib/osx/libgit2-8e0b172.dylib" />
|
||||
<dllmap os="linux" cpu="x86-64" wordsize="64" dll="git2-a904fc6" target="lib/linux-x64/libgit2-a904fc6.so" />
|
||||
<dllmap os="osx" cpu="x86,x86-64" dll="git2-a904fc6" target="lib/osx/libgit2-a904fc6.dylib" />
|
||||
</configuration>
|
||||
|
||||
Binary file not shown.
BIN
docs/_template/last-modified/plugins/lib/alpine-x64/libgit2-a904fc6.so
vendored
Normal file
BIN
docs/_template/last-modified/plugins/lib/alpine-x64/libgit2-a904fc6.so
vendored
Normal file
Binary file not shown.
Binary file not shown.
BIN
docs/_template/last-modified/plugins/lib/debian.9-x64/libgit2-a904fc6.so
vendored
Normal file
BIN
docs/_template/last-modified/plugins/lib/debian.9-x64/libgit2-a904fc6.so
vendored
Normal file
Binary file not shown.
Binary file not shown.
BIN
docs/_template/last-modified/plugins/lib/fedora-x64/libgit2-a904fc6.so
vendored
Normal file
BIN
docs/_template/last-modified/plugins/lib/fedora-x64/libgit2-a904fc6.so
vendored
Normal file
Binary file not shown.
Binary file not shown.
BIN
docs/_template/last-modified/plugins/lib/linux-x64/libgit2-a904fc6.so
vendored
Normal file
BIN
docs/_template/last-modified/plugins/lib/linux-x64/libgit2-a904fc6.so
vendored
Normal file
Binary file not shown.
Binary file not shown.
BIN
docs/_template/last-modified/plugins/lib/osx/libgit2-a904fc6.dylib
vendored
Normal file
BIN
docs/_template/last-modified/plugins/lib/osx/libgit2-a904fc6.dylib
vendored
Normal file
Binary file not shown.
Binary file not shown.
BIN
docs/_template/last-modified/plugins/lib/rhel-x64/libgit2-a904fc6.so
vendored
Normal file
BIN
docs/_template/last-modified/plugins/lib/rhel-x64/libgit2-a904fc6.so
vendored
Normal file
Binary file not shown.
BIN
docs/_template/last-modified/plugins/lib/ubuntu.18.04-x64/libgit2-a904fc6.so
vendored
Normal file
BIN
docs/_template/last-modified/plugins/lib/ubuntu.18.04-x64/libgit2-a904fc6.so
vendored
Normal file
Binary file not shown.
Binary file not shown.
BIN
docs/_template/last-modified/plugins/lib/win32/x64/git2-a904fc6.dll
vendored
Normal file
BIN
docs/_template/last-modified/plugins/lib/win32/x64/git2-a904fc6.dll
vendored
Normal file
Binary file not shown.
Binary file not shown.
BIN
docs/_template/last-modified/plugins/lib/win32/x86/git2-a904fc6.dll
vendored
Normal file
BIN
docs/_template/last-modified/plugins/lib/win32/x86/git2-a904fc6.dll
vendored
Normal file
Binary file not shown.
21
docs/_template/light-dark-theme/docfx-material-license.md
vendored
Normal file
21
docs/_template/light-dark-theme/docfx-material-license.md
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2019 Oscar Vásquez
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -15,6 +15,7 @@
|
||||
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
|
||||
<link rel="stylesheet" href="{{_rel}}styles/master.css">
|
||||
<link rel="stylesheet" href="{{_rel}}styles/main.css">
|
||||
<link rel="stylesheet" href="{{_rel}}styles/material.css">
|
||||
<link rel="stylesheet" href="{{_rel}}styles/theme-switcher.css">
|
||||
<link href="https://cdn.rawgit.com/noelboss/featherlight/1.7.6/release/featherlight.min.css" type="text/css" rel="stylesheet" />
|
||||
<meta name="theme-color" content="#99AAB5"/>
|
||||
|
||||
14
docs/_template/light-dark-theme/styles/dark.css
vendored
14
docs/_template/light-dark-theme/styles/dark.css
vendored
@@ -7,6 +7,15 @@ body {
|
||||
color: #C0C0C0;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
color: #E0E0E0;
|
||||
}
|
||||
|
||||
button,
|
||||
a {
|
||||
color: #64B5F6;
|
||||
@@ -258,6 +267,11 @@ tbody>tr {
|
||||
border-top: 2px solid rgb(173, 173, 173)
|
||||
}
|
||||
|
||||
/* top navbar */
|
||||
.navbar-inverse[role="navigation"] {
|
||||
background-color: #2C2F33;
|
||||
}
|
||||
|
||||
/* select */
|
||||
|
||||
select {
|
||||
|
||||
@@ -361,7 +361,6 @@ pre {
|
||||
word-break: break-all;
|
||||
word-wrap: break-word;
|
||||
color: #333;
|
||||
border: 1px solid #ccc;
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
|
||||
15
docs/_template/light-dark-theme/styles/gray.css
vendored
15
docs/_template/light-dark-theme/styles/gray.css
vendored
@@ -7,6 +7,15 @@ body {
|
||||
color: #dddddd;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
color: #EEEEEE;
|
||||
}
|
||||
|
||||
button,
|
||||
a {
|
||||
color: #64B5F6;
|
||||
@@ -39,13 +48,13 @@ hr {
|
||||
}
|
||||
|
||||
/* top navbar */
|
||||
.navbar-inverse[role="navigation"] {
|
||||
/*.navbar-inverse[role="navigation"] {
|
||||
background-color: #2C2F33;
|
||||
}
|
||||
}*/
|
||||
|
||||
/* sub navbar (below top) */
|
||||
.subnav {
|
||||
background: #282B2F
|
||||
background: rgb(69, 75, 82)
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -1,14 +1,37 @@
|
||||
@import url('https://fonts.googleapis.com/css?family=Titillium+Web|Noto+Sans');
|
||||
@import url('https://fonts.googleapis.com/css?family=Roboto|Muli|Fira+Mono');
|
||||
|
||||
html,
|
||||
body {
|
||||
font-family: 'Titillium Web', 'Segoe UI', Tahoma, Helvetica, sans-serif;
|
||||
font-family: 'Roboto', 'Segoe UI', Tahoma, Helvetica, sans-serif;
|
||||
font-display: optional;
|
||||
height: 100%;
|
||||
font-size: 15px;
|
||||
scroll-behavior: smooth;
|
||||
}
|
||||
|
||||
code{
|
||||
font-family: 'Fira Mono', 'Courier New', Courier, monospace
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
font-family: 'Muli', Verdana, Geneva, Tahoma, sans-serif;
|
||||
line-height: 130%;
|
||||
}
|
||||
|
||||
h1,
|
||||
.h1,
|
||||
h2,
|
||||
.h2,
|
||||
h3,
|
||||
.h3 {
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
#logo
|
||||
{
|
||||
max-width: 100px;
|
||||
@@ -25,6 +48,14 @@ li,
|
||||
line-height: 160%;
|
||||
}
|
||||
|
||||
.toc-filter{
|
||||
background: inherit !important;
|
||||
}
|
||||
|
||||
.affix ul>li.active>ul, .affix ul>li.active>a:before, .affix ul>li>a:hover:before{
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
img {
|
||||
box-shadow: 0px 0px 3px 0px rgb(66, 66, 66);
|
||||
max-width: 95% !important;
|
||||
@@ -57,16 +88,6 @@ article.content h6{
|
||||
transition: all .25s ease-in-out;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
font-family: 'Noto Sans', Verdana, Geneva, Tahoma, sans-serif;
|
||||
line-height: 130%;
|
||||
}
|
||||
|
||||
.sideaffix {
|
||||
line-height: 140%;
|
||||
}
|
||||
@@ -173,3 +194,38 @@ span.arrow-d{
|
||||
span.arrow-r{
|
||||
top: 6px; position: relative;
|
||||
}
|
||||
|
||||
/* widen viewport */
|
||||
|
||||
@media (min-width: 1085px) {
|
||||
.container {
|
||||
width: calc(100% - 15vw);
|
||||
max-width: calc(100% - 15vw);
|
||||
}
|
||||
}
|
||||
|
||||
/* fix level indentation */
|
||||
|
||||
.level2 {
|
||||
padding: 0 5px;
|
||||
}
|
||||
|
||||
.level3 {
|
||||
padding: 0 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
.level4 {
|
||||
padding: 0 5px;
|
||||
font-size: 85%;
|
||||
}
|
||||
|
||||
.level5 {
|
||||
padding: 0 5px;
|
||||
font-size: 80%;
|
||||
}
|
||||
|
||||
.level6 {
|
||||
padding: 0 5px;
|
||||
font-size: 75%;
|
||||
}
|
||||
199
docs/_template/light-dark-theme/styles/material.css
vendored
Normal file
199
docs/_template/light-dark-theme/styles/material.css
vendored
Normal file
@@ -0,0 +1,199 @@
|
||||
body {
|
||||
color: #34393e;
|
||||
line-height: 1.5;
|
||||
/*font-size: 16px;*/
|
||||
-ms-text-size-adjust: 100%;
|
||||
-webkit-text-size-adjust: 100%;
|
||||
word-wrap: break-word
|
||||
}
|
||||
|
||||
/* HEADINGS */
|
||||
|
||||
h1 {
|
||||
font-weight: 600;
|
||||
font-size: 32px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-weight: 600;
|
||||
font-size: 24px;
|
||||
line-height: 1.8;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-weight: 600;
|
||||
font-size: 20px;
|
||||
line-height: 1.8;
|
||||
}
|
||||
|
||||
h5 {
|
||||
font-size: 14px;
|
||||
padding: 10px 0px;
|
||||
}
|
||||
|
||||
article h1,
|
||||
article h2,
|
||||
article h3,
|
||||
article h4 {
|
||||
margin-top: 35px;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
article h4 {
|
||||
padding-bottom: 8px;
|
||||
border-bottom: 2px solid #ddd;
|
||||
}
|
||||
|
||||
/* NAVBAR */
|
||||
|
||||
.navbar-brand>img {
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
.navbar {
|
||||
border: none;
|
||||
/* Both navbars use box-shadow */
|
||||
-webkit-box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
|
||||
-moz-box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
|
||||
box-shadow: 0px 1px 3px 0px rgba(100, 100, 100, 0.5);
|
||||
}
|
||||
|
||||
.subnav {
|
||||
border-top: 1px solid #ddd;
|
||||
background-color: #fff;
|
||||
}
|
||||
|
||||
.navbar-inverse {
|
||||
background-color: #0d47a1;
|
||||
z-index: 100;
|
||||
}
|
||||
|
||||
.navbar-inverse .navbar-nav>li>a,
|
||||
.navbar-inverse .navbar-text {
|
||||
color: #fff;
|
||||
/*background-color: #0d47a1;*/
|
||||
border-bottom: 3px solid transparent;
|
||||
padding-bottom: 12px;
|
||||
}
|
||||
|
||||
.navbar-inverse .navbar-nav>li>a:focus,
|
||||
.navbar-inverse .navbar-nav>li>a:hover {
|
||||
color: #fff;
|
||||
background-color: #1157c0;
|
||||
border-bottom: 3px solid white;
|
||||
}
|
||||
|
||||
.navbar-inverse .navbar-nav>.active>a,
|
||||
.navbar-inverse .navbar-nav>.active>a:focus,
|
||||
.navbar-inverse .navbar-nav>.active>a:hover {
|
||||
color: #fff;
|
||||
background-color: #1157c0;
|
||||
border-bottom: 3px solid white;
|
||||
}
|
||||
|
||||
.navbar-form .form-control {
|
||||
border: none;
|
||||
border-radius: 20px;
|
||||
}
|
||||
|
||||
/* SIDEBAR */
|
||||
|
||||
/*.toc .level1>li {
|
||||
font-weight: 400;
|
||||
}*/
|
||||
|
||||
.toc .nav>li>a {
|
||||
color: #34393e;
|
||||
}
|
||||
|
||||
.sidefilter {
|
||||
background-color: #fff;
|
||||
border-left: none;
|
||||
border-right: none;
|
||||
}
|
||||
|
||||
.sidefilter {
|
||||
background-color: #fff;
|
||||
border-left: none;
|
||||
border-right: none;
|
||||
}
|
||||
|
||||
.toc-filter {
|
||||
padding: 10px;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.toc-filter>input {
|
||||
border: 2px solid #ddd;
|
||||
border-radius: 20px;
|
||||
}
|
||||
|
||||
.toc-filter>.filter-icon {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.sidetoc>.toc {
|
||||
overflow-x: hidden;
|
||||
}
|
||||
|
||||
.sidetoc {
|
||||
border: none;
|
||||
}
|
||||
|
||||
/* ALERTS */
|
||||
|
||||
.alert {
|
||||
padding: 0px 0px 5px 0px;
|
||||
color: inherit;
|
||||
background-color: inherit;
|
||||
border: none;
|
||||
box-shadow: 0px 2px 2px 0px rgba(100, 100, 100, 0.4);
|
||||
}
|
||||
|
||||
.alert>p {
|
||||
margin-bottom: 0;
|
||||
padding: 5px 10px;
|
||||
}
|
||||
|
||||
.alert>ul {
|
||||
margin-bottom: 0;
|
||||
padding: 5px 40px;
|
||||
}
|
||||
|
||||
.alert>h5 {
|
||||
padding: 10px 15px;
|
||||
margin-top: 0;
|
||||
text-transform: uppercase;
|
||||
font-weight: bold;
|
||||
border-radius: 4px 4px 0 0;
|
||||
}
|
||||
|
||||
.alert-info>h5 {
|
||||
color: #1976d2;
|
||||
border-bottom: 4px solid #1976d2;
|
||||
background-color: #e3f2fd;
|
||||
}
|
||||
|
||||
.alert-warning>h5 {
|
||||
color: #f57f17;
|
||||
border-bottom: 4px solid #f57f17;
|
||||
background-color: #fff3e0;
|
||||
}
|
||||
|
||||
.alert-danger>h5 {
|
||||
color: #d32f2f;
|
||||
border-bottom: 4px solid #d32f2f;
|
||||
background-color: #ffebee;
|
||||
}
|
||||
|
||||
/* CODE HIGHLIGHT */
|
||||
pre {
|
||||
padding: 9.5px;
|
||||
margin: 10px 10px 10px;
|
||||
font-size: 13px;
|
||||
word-break: break-all;
|
||||
word-wrap: break-word;
|
||||
/*background-color: #fffaef;*/
|
||||
border-radius: 4px;
|
||||
box-shadow: 0px 1px 4px 1px rgba(100, 100, 100, 0.4);
|
||||
}
|
||||
Reference in New Issue
Block a user