Skip to content

Commit

Permalink
Update docfx (#534)
Browse files Browse the repository at this point in the history
  • Loading branch information
wcoder authored Oct 27, 2023
1 parent f87e2c8 commit 4fdd0da
Show file tree
Hide file tree
Showing 6 changed files with 313 additions and 41 deletions.
2 changes: 1 addition & 1 deletion documentation/build.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

DOCFX_VERSION="2.62.1"
DOCFX_VERSION="2.71.1"
DOCFX_CONFIG_PATH="docfx.json"

# install tool
Expand Down
37 changes: 31 additions & 6 deletions documentation/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,43 @@
"src": [
{
"files": [
"**/Softeq.XToolkit.*.csproj"
"Softeq.XToolkit.Bindings/bin/Release/*/Softeq.XToolkit.Bindings.dll",
"Softeq.XToolkit.Bindings.Droid/bin/Release/*/Softeq.XToolkit.Bindings.Droid.dll",
"Softeq.XToolkit.Bindings.iOS/bin/Release/*/Softeq.XToolkit.Bindings.iOS.dll",

"Softeq.XToolkit.Common/bin/Release/*/Softeq.XToolkit.Common.dll",
"Softeq.XToolkit.Common.Droid/bin/Release/*/Softeq.XToolkit.Common.Droid.dll",
"Softeq.XToolkit.Common.iOS/bin/Release/*/Softeq.XToolkit.Common.iOS.dll",

"Softeq.XToolkit.Connectivity/bin/Release/*/Softeq.XToolkit.Connectivity.dll",
"Softeq.XToolkit.Connectivity.iOS/bin/Release/*/Softeq.XToolkit.Connectivity.iOS.dll",

"Softeq.XToolkit.Permissions/bin/Release/*/Softeq.XToolkit.Permissions.dll",
"Softeq.XToolkit.Permissions.Droid/bin/Release/*/Softeq.XToolkit.Permissions.Droid.dll",
"Softeq.XToolkit.Permissions.iOS/bin/Release/*/Softeq.XToolkit.Permissions.iOS.dll",

"Softeq.XToolkit.PushNotifications/bin/Release/*/Softeq.XToolkit.PushNotifications.dll",
"Softeq.XToolkit.PushNotifications.Droid/bin/Release/*/Softeq.XToolkit.PushNotifications.Droid.dll",
"Softeq.XToolkit.PushNotifications.iOS/bin/Release/*/Softeq.XToolkit.PushNotifications.iOS.dll",

"Softeq.XToolkit.Remote/bin/Release/*/Softeq.XToolkit.Remote.dll",

"Softeq.XToolkit.WhiteLabel/bin/Release/*/Softeq.XToolkit.WhiteLabel.dll",
"Softeq.XToolkit.WhiteLabel.Droid/bin/Release/*/Softeq.XToolkit.WhiteLabel.Droid.dll",
"Softeq.XToolkit.WhiteLabel.iOS/bin/Release/*/Softeq.XToolkit.WhiteLabel.iOS.dll",

"Softeq.XToolkit.WhiteLabel.Essentials/bin/Release/*/Softeq.XToolkit.WhiteLabel.Essentials.dll",
"Softeq.XToolkit.WhiteLabel.Essentials.Droid/bin/Release/*/Softeq.XToolkit.WhiteLabel.Essentials.Droid.dll",
"Softeq.XToolkit.WhiteLabel.Essentials.iOS/bin/Release/*/Softeq.XToolkit.WhiteLabel.Essentials.iOS.dll"
],
"src": "..",
"exclude": [
"**/obj/**",
"**/bin/**",
"**/*.Tests.csproj",
"**/*.Forms.csproj",
"_site/**"
]
}
],
"dest": "obj/docfxapi",
"filter": "filterConfig.yml",
"namespaceLayout": "nested"
}
],
Expand Down Expand Up @@ -94,7 +118,8 @@
"dest": "_site",
"template": [
"statictoc",
"templates/material"
"modern",
"templates/material-modern"
]
}
}
4 changes: 4 additions & 0 deletions documentation/filterConfig.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
apiRules:
- exclude:
uidRegex: Droid\.Resource
type: Class
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@100;400;700&display=swap');

/* COLOR VARIABLES*/
:root {
--header-bg-color: #00adff;
--header-ft-color: #fff;
--highlight-light: #45c3ff;
--highlight-dark: #00adff;
--font-color: #000;
--custom-box-shadow: 0 1px 2px 0 rgba(61, 65, 68, 0.06), 0 1px 3px 1px rgba(61, 65, 68, 0.16);
--accent-dim: #e0e0e0;
--accent-super-dim: #f3f3f3;
--font-color: #34393e;
--card-box-shadow: 0 1px 2px 0 rgba(61, 65, 68, 0.06), 0 1px 3px 1px rgba(61, 65, 68, 0.16);
--search-box-shadow: 0 1px 2px 0 rgba(41, 45, 48, 0.36), 0 1px 3px 1px rgba(41, 45, 48, 0.46);
--transition: 350ms;
}

body {
color: var(--font-color);
font-family: sans-serif;
font-family: 'Roboto', sans-serif;
line-height: 1.5;
font-size: 16px;
-ms-text-size-adjust: 100%;
Expand Down Expand Up @@ -104,9 +110,9 @@ article h4 {
.navbar {
border: none;
/* Both navbars use box-shadow */
-webkit-box-shadow: var(--custom-box-shadow);
-moz-box-shadow: var(--custom-box-shadow);
box-shadow: var(--custom-box-shadow);
-webkit-box-shadow: var(--card-box-shadow);
-moz-box-shadow: var(--card-box-shadow);
box-shadow: var(--card-box-shadow);
}

.subnav {
Expand All @@ -125,6 +131,7 @@ article h4 {
background-color: var(--header-bg-color);
border-bottom: 3px solid transparent;
padding-bottom: 12px;
transition: 350ms;
}

.navbar-inverse .navbar-nav > li > a:focus,
Expand All @@ -143,8 +150,30 @@ article h4 {
}

.navbar-form .form-control {
border: 0;
border-radius: 4px;
box-shadow: var(--search-box-shadow);
transition: var(--transition);
}

.navbar-form .form-control:hover {
background-color: var(--accent-dim);
}

/* NAVBAR TOGGLED (small screens) */

.navbar-inverse .navbar-collapse,
.navbar-inverse .navbar-form {
border: none;
}
.navbar-inverse .navbar-toggle {
box-shadow: var(--card-box-shadow);
border: none;
border-radius: 20px;
}

.navbar-inverse .navbar-toggle:focus,
.navbar-inverse .navbar-toggle:hover {
background-color: var(--highlight-dark);
}

/* SIDEBAR */
Expand All @@ -170,13 +199,20 @@ article h4 {
}

.toc-filter {
padding: 10px;
padding: 5px;
margin: 0;
box-shadow: var(--card-box-shadow);
transition: var(--transition);
}

.toc-filter:hover {
background-color: var(--accent-super-dim);
}

.toc-filter > input {
border: 2px solid #ddd;
border-radius: 20px;
border: none;
background-color: inherit;
transition: inherit;
}

.toc-filter > .filter-icon {
Expand All @@ -200,7 +236,7 @@ article h4 {
color: inherit;
background-color: inherit;
border: none;
box-shadow: var(--custom-box-shadow);
box-shadow: var(--card-box-shadow);
}

.alert > p {
Expand Down Expand Up @@ -249,13 +285,36 @@ pre {
background-color: #fffaef;
border-radius: 4px;
border: none;
box-shadow: var(--custom-box-shadow);
box-shadow: var(--card-box-shadow);
}

/* STYLE FOR IMAGES */

.article .small-image {
margin-top: 15px;
box-shadow: var(--card-box-shadow);
max-width: 350px;
}

.article .medium-image {
margin-top: 15px;
box-shadow: var(--card-box-shadow);
max-width: 550px;
}

.article .large-image {
margin-top: 15px;
box-shadow: var(--card-box-shadow);
max-width: 700px;
}


/* SOFTEQ CUSTOM STYLES */

.navbar-brand > img {
height: 40px;
padding-top: 10px;
width: 20px;
margin-top: 12px;
margin-right: 20px;
}
.toc ul.nav.level3 {
margin: 0 0 0 10px;
Expand Down
Loading

0 comments on commit 4fdd0da

Please sign in to comment.