diff --git a/documentation/build.sh b/documentation/build.sh index d988599a9..221854d5c 100644 --- a/documentation/build.sh +++ b/documentation/build.sh @@ -1,6 +1,6 @@ #!/bin/bash -DOCFX_VERSION="2.62.1" +DOCFX_VERSION="2.71.1" DOCFX_CONFIG_PATH="docfx.json" # install tool diff --git a/documentation/docfx.json b/documentation/docfx.json index 2a7916bb4..5d091e4b7 100644 --- a/documentation/docfx.json +++ b/documentation/docfx.json @@ -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" } ], @@ -94,7 +118,8 @@ "dest": "_site", "template": [ "statictoc", - "templates/material" + "modern", + "templates/material-modern" ] } } \ No newline at end of file diff --git a/documentation/filterConfig.yml b/documentation/filterConfig.yml new file mode 100644 index 000000000..f1d3324da --- /dev/null +++ b/documentation/filterConfig.yml @@ -0,0 +1,4 @@ +apiRules: +- exclude: + uidRegex: Droid\.Resource + type: Class \ No newline at end of file diff --git a/documentation/templates/material/styles/main.css b/documentation/templates/material-classic/styles/main.css similarity index 69% rename from documentation/templates/material/styles/main.css rename to documentation/templates/material-classic/styles/main.css index a37a4df96..d100f389d 100644 --- a/documentation/templates/material/styles/main.css +++ b/documentation/templates/material-classic/styles/main.css @@ -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%; @@ -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 { @@ -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, @@ -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 */ @@ -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 { @@ -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 { @@ -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; diff --git a/documentation/templates/material-modern/public/main.css b/documentation/templates/material-modern/public/main.css new file mode 100644 index 000000000..670011b94 --- /dev/null +++ b/documentation/templates/material-modern/public/main.css @@ -0,0 +1,204 @@ +@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@100;400;700&display=swap'); + +:root { + --bs-font-sans-serif: 'Roboto'; + --bs-border-radius: 10px; + + --border-radius-button: 40px; + --card-box-shadow: 0 1px 2px 0 #3d41440f, 0 1px 3px 1px #3d414429; + + --material-yellow-light: #e6dfbf; + --material-yellow-dark: #5a5338; + + --material-blue-light: #c4d9f1; + --material-blue-dark: #383e5a; + + --material-red-light: #f1c4c4; + --material-red-dark: #5a3838; + + --material-warning-header: #f57f171a; + --material-warning-background: #f6e8bd; + --material-warning-background-dark: #57502c; + + --material-info-header: #1976d21a; + --material-info-background: #e3f2fd; + --material-info-background-dark: #2c4557; + + --material-danger-header: #d32f2f1a; + --material-danger-background: #ffebee; + --material-danger-background-dark: #572c2c; +} + +/* 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 h2, +article h3, +article h4 { + margin-top: 15px; + margin-bottom: 15px; +} + +article h4 { + padding-bottom: 8px; + border-bottom: 2px solid #ddd; +} + +/** IMAGES **/ +img { + border-radius: var(--bs-border-radius); + box-shadow: var(--card-box-shadow); +} + +/** NAVBAR **/ +.navbar-brand > img { + box-shadow: none; + color: var(--bs-nav-link-color); +} + +[data-bs-theme='light'] nav.navbar { + background-color: var(--bs-primary-bg-subtle); +} + +[data-bs-theme='dark'] nav.navbar { + background-color: var(--bs-tertiary-bg); +} + +.navbar-nav > li > a { + border-radius: var(--border-radius-button); + transition: 200ms; +} + +.navbar-nav a.nav-link:focus, +.navbar-nav a.nav-link:hover { + background-color: var(--bs-primary-border-subtle); +} + +.navbar-nav .nav-link.active, +.navbar-nav .nav-link.show { + color: var(--bs-link-hover-color); +} + +/** SEARCH AND FILTER **/ +input.form-control { + border-radius: var(--border-radius-button); +} + +form.filter { + margin: 0.3rem; +} + +/** ALERTS **/ +.alert { + padding: 0; + border: none; + box-shadow: var(--card-box-shadow); +} + +.alert > p { + padding: 0.2rem 0.7rem 0.7rem 1rem; +} + +.alert > ul { + margin-bottom: 0; + padding: 5px 40px; +} + +.alert > h5 { + padding: 0.5rem 0.7rem 0.7rem 1rem; + border-radius: var(--bs-border-radius) var(--bs-border-radius) 0 0; + font-weight: bold; + text-transform: capitalize; +} + +.alert-info { + color: var(--material-blue-dark); + background-color: var(--material-info-background); +} + +[data-bs-theme='dark'] .alert-info { + color: var(--material-blue-light); + background-color: var(--material-info-background-dark); +} + +.alert-info > h5 { + background-color: var(--material-info-header); +} + +.alert-warning { + color: var(--material-yellow-dark); + background-color: var(--material-warning-background); +} + +[data-bs-theme='dark'] .alert-warning { + color: var(--material-yellow-light); + background-color: var(--material-warning-background-dark); +} + +.alert-warning > h5 { + background-color: var(--material-warning-header); +} + +.alert-danger { + color: var(--material-red-dark); + background-color: var(--material-danger-background); +} + +[data-bs-theme='dark'] .alert-danger { + color: var(--material-red-light); + background-color: var(--material-danger-background-dark); +} + +.alert-danger > h5 { + background-color: var(--material-danger-header); +} + +/* CODE HIGHLIGHT */ +code { + border-radius: var(--bs-border-radius); + margin: 4px 2px; + box-shadow: var(--card-box-shadow); +} + +/* SOFTEQ CUSTOM STYLES */ + +.navbar-brand > img { + width: 30px; + margin-left: 10px; + border-radius: 0; +} +/* .toc ul.nav.level3 { + margin: 0 0 0 10px; +} +.toc ul.nav li { + margin: 4px 0 4px 0; +} */ +.footer-docfx { + color: #ccc; + display: block; + font-size: 12px; +} +code { + padding: 2px 8px; +} diff --git a/documentation/templates/material/partials/head.tmpl.partial b/documentation/templates/material/partials/head.tmpl.partial deleted file mode 100644 index 83fc5f91a..000000000 --- a/documentation/templates/material/partials/head.tmpl.partial +++ /dev/null @@ -1,20 +0,0 @@ -{{!Copyright (c) Oscar Vasquez. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - -
- - -