diff --git a/docfx/.gitignore b/docfx/.gitignore index 9e0634d5..e6b20bae 100644 --- a/docfx/.gitignore +++ b/docfx/.gitignore @@ -7,4 +7,6 @@ /**/bin/ /**/obj/ _exported_templates -_site \ No newline at end of file +_site +*.yml +.manifest \ No newline at end of file diff --git a/docfx/docfx.json b/docfx/docfx.json index 124a0424..a818959f 100644 --- a/docfx/docfx.json +++ b/docfx/docfx.json @@ -3,30 +3,18 @@ { "src": [ { - "files": [ - "**/Textkernel.Tx.SDK/**.csproj" - ], - "src": "../src" + "files": ["**/Textkernel.Tx.SDK/**.csproj"], + "src": "../src" } ], - "dest": "sdk", - "disableGitFeatures": false, - "disableDefaultFilter": false + "dest": ".", + "namespaceLayout": "Nested" } ], "build": { "content": [ { - "files": [ - "sdk/**.yml", - "sdk/index.md" - ] - }, - { - "files": [ - "toc.yml", - "*.md" - ] + "files": "**/*.{md,yml}" } ], "resource": [ @@ -36,25 +24,22 @@ ] } ], - "overwrite": [ - { - "files": [ - "apidoc/**.md" - ], - "exclude": [ - "obj/**", - "_site/**" - ] - } - ], "dest": "_site", - "globalMetadataFiles": [], - "fileMetadataFiles": [], + "globalMetadata": { + "_disableContribution": "true", + "_appFaviconPath": "images/favicon.svg", + "_appLogoPath": "images/logo.png", + "_appTitle": "Textkernel SDK", + "_appName": "Textkernel Tx Platform .NET SDK", + "_enableSearch": true, + "_disableToc": false, + "_disableAffix": false, + "_disableNavbar": false + }, "template": [ "default", - "templates/darkfx" + "modern" ], - "postProcessors": [], "markdownEngineName": "markdig", "noLangKeyword": false, "keepFileLink": false, diff --git a/docfx/images/favicon.ico b/docfx/images/favicon.ico deleted file mode 100644 index 605dcf1a..00000000 Binary files a/docfx/images/favicon.ico and /dev/null differ diff --git a/docfx/images/favicon.svg b/docfx/images/favicon.svg new file mode 100644 index 00000000..e82b7303 --- /dev/null +++ b/docfx/images/favicon.svg @@ -0,0 +1,65 @@ + + + + + + + diff --git a/docfx/images/logo.png b/docfx/images/logo.png new file mode 100644 index 00000000..edf20541 Binary files /dev/null and b/docfx/images/logo.png differ diff --git a/docfx/index.md b/docfx/index.md index 43bcbf79..418e9593 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -1,4 +1,31 @@ -# tx-dotnet -Return to the project main page on GitHub [here][gh-url] +# Textkernel Tx .NET SDK Documentation +This is the auto-generated (by [DocFX](https://dotnet.github.io/docfx/)) documentation for the SDK codebase. +If you were looking for best-practices, transaction costs, or other API documentation, you +can find that [here](https://developer.textkernel.com/tx-platform/v10/overview/). + +You can also go back to the [GitHub project page](https://github.com/textkernel/tx-dotnet) for more usage information and examples. + +## Basics + - @"Textkernel.Tx.TxClient" - the core class of the SDK. It is used to make all of the API calls. + - @"Textkernel.Tx.DataCenter" - used to point the @"Textkernel.Tx.TxClient" at the correct data center for your account. + - @"Textkernel.Tx.TxException" - the @"Textkernel.Tx.TxClient" will throw these during normal operations, for example, when you try to parse a resume that is a scanned image. See the GitHub project page for more information and examples. + +## Services +- @"Textkernel.Tx.TxClient.Parser" - provides all parsing functionality. +- @"Textkernel.Tx.TxClient.Geocoder" - determines geocoordinates based on addresses. +- @"Textkernel.Tx.TxClient.Formatter" - transforms a parsed resume into a standard/templated format. +- @"Textkernel.Tx.TxClient.SkillsIntelligence" - provides all Skills Intelligence functionality. +- @"Textkernel.Tx.TxClient.SearchMatchV1" - provides all Search & Match V1 functionality. +- @"Textkernel.Tx.TxClient.SearchMatchV2" - provides all Search & Match V2 functionality. + +## Core Models + - @"Textkernel.Tx.Models.Document" - represents an unparsed resume/job, such as a file on the file system or a byte[] in a database. This is what you pass to the @"Textkernel.Tx.TxClient" for parsing. + - @"Textkernel.Tx.Models.Resume.ParsedResume" - contains all of the properties/information that is extracted when a resume/cv is parsed. + - @"Textkernel.Tx.Models.Job.ParsedJob" - contains all of the properties/information that is extracted when a job description is parsed. + - @"Textkernel.Tx.Models.API.ApiResponseInfo" - returned with every API call, this contains information about the transaction (error messages, cost, duration, account information, etc). + + + + [gh-url]: https://github.com/textkernel/tx-dotnet/ diff --git a/docfx/sdk/.gitignore b/docfx/sdk/.gitignore deleted file mode 100644 index e8079a3b..00000000 --- a/docfx/sdk/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -############### -# temp file # -############### -*.yml -.manifest diff --git a/docfx/sdk/index.md b/docfx/sdk/index.md deleted file mode 100644 index 55eb3ae4..00000000 --- a/docfx/sdk/index.md +++ /dev/null @@ -1,27 +0,0 @@ -# Textkernel Tx .NET SDK Documentation -This is the auto-generated (by [DocFX](https://dotnet.github.io/docfx/)) documentation for the SDK codebase. -If you were looking for best-practices, transaction costs, or other API documentation, you -can find that [here](https://developer.textkernel.com/tx-platform/v10/overview/). - -You can also go back to the [GitHub project page](https://github.com/textkernel/tx-dotnet) for more usage information and examples. - -## Basics - - @"Textkernel.Tx.TxClient" - the core class of the SDK. It is used to make all of the API calls. - - @"Textkernel.Tx.DataCenter" - used to point the @"Textkernel.Tx.TxClient" at the correct data center for your account. - - @"Textkernel.Tx.TxException" - the @"Textkernel.Tx.TxClient" will throw these during normal operations, for example, when you try to parse a resume that is a scanned image. See the GitHub project page for more information and examples. - -## Services -- @"Textkernel.Tx.TxClient.Parser" - provides all parsing functionality. -- @"Textkernel.Tx.TxClient.Geocoder" - determines geocoordinates based on addresses. -- @"Textkernel.Tx.TxClient.Formatter" - transforms a parsed resume into a standard/templated format. -- @"Textkernel.Tx.TxClient.SkillsIntelligence" - provides all Skills Intelligence functionality. -- @"Textkernel.Tx.TxClient.SearchMatchV1" - provides all Search & Match V1 functionality. -- @"Textkernel.Tx.TxClient.SearchMatchV2" - provides all Search & Match V2 functionality. - -## Core Models - - @"Textkernel.Tx.Models.Document" - represents an unparsed resume/job, such as a file on the file system or a byte[] in a database. This is what you pass to the @"Textkernel.Tx.TxClient" for parsing. - - @"Textkernel.Tx.Models.Resume.ParsedResume" - contains all of the properties/information that is extracted when a resume/cv is parsed. - - @"Textkernel.Tx.Models.Job.ParsedJob" - contains all of the properties/information that is extracted when a job description is parsed. - - @"Textkernel.Tx.Models.API.ApiResponseInfo" - returned with every API call, this contains information about the transaction (error messages, cost, duration, account information, etc). - - diff --git a/docfx/templates/darkfx/partials/affix.tmpl.partial b/docfx/templates/darkfx/partials/affix.tmpl.partial deleted file mode 100644 index 11caeb3d..00000000 --- a/docfx/templates/darkfx/partials/affix.tmpl.partial +++ /dev/null @@ -1,40 +0,0 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - - diff --git a/docfx/templates/darkfx/partials/footer.tmpl.partial b/docfx/templates/darkfx/partials/footer.tmpl.partial deleted file mode 100644 index a9da7c3b..00000000 --- a/docfx/templates/darkfx/partials/footer.tmpl.partial +++ /dev/null @@ -1,29 +0,0 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - - \ No newline at end of file diff --git a/docfx/templates/darkfx/partials/head.tmpl.partial b/docfx/templates/darkfx/partials/head.tmpl.partial deleted file mode 100644 index b799923f..00000000 --- a/docfx/templates/darkfx/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.}} - - - - - {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} - - - - {{#_description}}{{/_description}} - - - - - - - {{#_noindex}}{{/_noindex}} - {{#_enableSearch}}{{/_enableSearch}} - {{#_enableNewTab}}{{/_enableNewTab}} - \ No newline at end of file diff --git a/docfx/templates/darkfx/partials/logo.tmpl.partial b/docfx/templates/darkfx/partials/logo.tmpl.partial deleted file mode 100644 index 2d11c623..00000000 --- a/docfx/templates/darkfx/partials/logo.tmpl.partial +++ /dev/null @@ -1,17 +0,0 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} - - - - Group - - - - - - - - - diff --git a/docfx/templates/darkfx/styles/main.css b/docfx/templates/darkfx/styles/main.css deleted file mode 100644 index 5c5ddd69..00000000 --- a/docfx/templates/darkfx/styles/main.css +++ /dev/null @@ -1,482 +0,0 @@ -:root, body.dark-theme { - --color-foreground: #ccd5dc; - --color-navbar: #66666d; - --color-breadcrumb: #999; - --color-underline: #ddd; - --color-toc-hover: #fff; - --color-background: #2d2d30; - --color-background-subnav: #333337; - --color-background-dark: #1e1e1e; - --color-background-table-alt: #212123; - --color-background-quote: #69696e; - --color-foreground-code: #a6a6a6; - --color-foreground-light: #f2f9ff; -} - -body.light-theme { - --color-foreground: #171717; - --color-breadcrumb: #4a4a4a; - --color-toc-hover: #4c4c4c; - --color-background: #ffffff; - --color-background-subnav: #f5f5f5; - --color-background-dark: #ececec; - --color-background-table-alt: #f9f9f9; - --color-foreground-code: #555; - --color-foreground-light: #000000; -} - -body { - color: var(--color-foreground); - line-height: 1.5; - font-size: 15px; - -ms-text-size-adjust: 100%; - -webkit-text-size-adjust: 100%; - word-wrap: break-word; - background-color: var(--color-background); -} - -.btn.focus, .btn:focus, .btn:hover { - color: var(--color-foreground); -} - -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: 15px; - padding: 10px 0px; -} - -.sideaffix { - font-size: 14px; -} - -.sideaffix h5 { - font-size: 15px; -} - -article h1, article h2, article h3, article h4 { - margin-top: 35px; - margin-bottom: 15px; -} - -article h4 { - padding-bottom: 8px; - border-bottom: 2px solid var(--color-underline); -} - -.navbar-brand>img { - color: var(--color-background); -} - -.navbar { - border: none; -} - -.subnav { - border-top: 1px solid var(--color-underline); - background-color: var(--color-background-subnav); -} - -.sidenav, .fixed_header, .toc { - background-color: var(--color-background); -} - -.navbar-inverse { - background-color: var(--color-background-dark); - z-index: 100; -} - -.navbar-inverse .navbar-nav>li>a, .navbar-inverse .navbar-text { - color: var(--color-navbar); - background-color: var(--color-background-dark); - border-bottom: 3px solid transparent; - padding-bottom: 12px; -} - -.navbar-inverse .navbar-nav>li>a:focus, .navbar-inverse .navbar-nav>li>a:hover { - color: var(--color-foreground); - background-color: var(--color-background-dark); - border-bottom: 3px solid var(--color-background-subnav); - transition: all ease 0.25s; -} - -.navbar-inverse .navbar-nav>.active>a, .navbar-inverse .navbar-nav>.active>a:focus, .navbar-inverse .navbar-nav>.active>a:hover { - color: var(--color-foreground); - background-color: var(--color-background-dark); - border-bottom: 3px solid var(--color-foreground); - transition: all ease 0.25s; -} - -.navbar-form .form-control { - border: none; - border-radius: 0; -} - -.light-theme .navbar-brand svg { - filter: brightness(20%); -} - -.toc .level1>li { - font-weight: 400; -} - -.toc .nav>li>a { - color: var(--color-foreground); -} - -.sidefilter { - background-color: var(--color-background); - border-left: none; - border-right: none; -} - -.toc-filter { - padding: 10px; - margin: 0; - background-color: var(--color-background); -} - -.toc-filter>input { - border: none; - border-radius: unset; - background-color: var(--color-background-subnav); - color: var(--color-foreground); - padding: 5px 0 5px 20px; - font-size: 90% -} - -.toc-filter>.clear-icon { - position: absolute; - top: 17px; - right: 15px; -} - -.toc-filter>input:focus { - color: var(--color-foreground-light); - transition: all ease 0.25s; -} - -.toc-filter>.filter-icon { - display: none; -} - -.sidetoc>.toc { - background-color: var(--color-background); - overflow-x: hidden; -} - -.sidetoc { - background-color: var(--color-background); - border: none; -} - -.alert { - background-color: inherit; - border: none; - padding: 10px 0; - border-radius: 0; -} - -.alert>p { - margin-bottom: 0; - padding: 5px 10px; - border-bottom: 1px solid; - background-color: var(--color-background-dark); -} - -.alert>h5 { - padding: 10px 15px; - margin-top: 0; - margin-bottom: 0; - text-transform: uppercase; - font-weight: bold; - border-top: 2px solid; - background-color: var(--color-background-dark); - border-radius: none; -} - -.alert>ul { - margin-bottom: 0; - padding: 5px 40px; -} - -.alert-info { - color: #1976d2; -} - -.alert-warning { - color: #f57f17; -} - -.alert-danger { - color: #d32f2f; -} - -pre { - padding: 9.5px; - margin: 0 0 10px; - font-size: 14px; - word-break: break-all; - word-wrap: break-word; - background-color: var(--color-background-dark); - border-radius: 0; - border: none; -} - -code { - background: var(--color-background-dark) !important; - border-radius: 2px; -} - -code:not(.hljs) { - color: var(--color-foreground-code) !important; -} - -.hljs { - color: var(--color-foreground); -} - -.toc .nav>li.active>.expand-stub::before, .toc .nav>li.in>.expand-stub::before, .toc .nav>li.in.active>.expand-stub::before, .toc .nav>li.filtered>.expand-stub::before { - content: "▾"; -} - -.toc .nav>li>.expand-stub::before, .toc .nav>li.active>.expand-stub::before { - content: "▸"; -} - -.affix ul ul>li>a:before { - content: "|"; -} - -.breadcrumb { - background-color: var(--color-background-subnav); -} - -.breadcrumb .label.label-primary { - background: #444; - border-radius: 0; - font-weight: normal; - font-size: 100%; -} - -#breadcrumb .breadcrumb>li a { - border-radius: 0; - font-weight: normal; - font-size: 85%; - display: inline; - padding: 0 .6em 0; - line-height: 1; - text-align: center; - white-space: nowrap; - vertical-align: baseline; - color: var(--color-breadcrumb); -} - -#breadcrumb .breadcrumb>li a:hover { - color: var(--color-foreground); - transition: all ease 0.25s; -} - -.breadcrumb>li+li:before { - content: "⯈"; - font-size: 75%; - color: var(--color-background-dark); - padding: 0; -} - -.light-theme .breadcrumb>li+li:before { - color: var(--color-foreground) - } - -.toc .level1>li { - font-weight: 600; - font-size: 130%; - padding-left: 5px; -} - -.footer { - border-top: none; - background-color: var(--color-background-dark); - padding: 15px 0; - font-size: 90%; -} - -.toc .nav>li>a:hover, .toc .nav>li>a:focus { - color: var(--color-toc-hover); - transition: all ease 0.1s; -} - -.form-control { - background-color: var(--color-background-subnav); - border: none; - border-radius: 0; - -webkit-box-shadow: none; - box-shadow: none; -} - -.form-control:focus { - border-color: #66afe9; - outline: 0; - -webkit-box-shadow: none; - box-shadow: none; -} - -input#search-query:focus { - color: var(--color-foreground); -} - -.table-bordered, .table-bordered>tbody>tr>td, .table-bordered>tbody>tr>th, .table-bordered>tfoot>tr>td, .table-bordered>tfoot>tr>th, .table-bordered>thead>tr>td, .table-bordered>thead>tr>th { - border: 1px solid var(--color-background-dark); -} - -.table-striped>tbody>tr:nth-of-type(odd) { - background-color: var(--color-background-table-alt); -} - -blockquote { - padding: 10px 20px; - margin: 0 0 10px; - font-size: 110%; - border-left: 5px solid var(--color-background-quote); - color: var(--color-background-quote); -} - -.pagination>.disabled>a, .pagination>.disabled>a:focus, .pagination>.disabled>a:hover, .pagination>.disabled>span, .pagination>.disabled>span:focus, .pagination>.disabled>span:hover { - background-color: var(--color-background-subnav); - border-color: var(--color-background-subnav); -} - -.breadcrumb>li, .pagination { - display: inline; -} - -.tabGroup a[role="tab"] { - border-bottom: 2px solid var(--color-background-dark); -} - -.tabGroup a[role="tab"][aria-selected="true"] { - color: var(--color-foreground); -} - -.tabGroup section[role="tabpanel"] { - border: 1px solid var(--color-background-dark); -} - -.sideaffix > div.contribution > ul > li > a.contribution-link:hover { - background-color: var(--color-background); -} - -.switch { - position: relative; - display: inline-block; - width: 40px; - height: 20px; -} - -.switch input { - opacity: 0; - width: 0; - height: 0; -} - -.slider { - position: absolute; - cursor: pointer; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: #ccc; - -webkit-transition: .4s; - transition: .4s; -} - -.slider:before { - position: absolute; - content: ""; - height: 14px; - width: 14px; - left: 4px; - bottom: 3px; - background-color: white; - -webkit-transition: .4s; - transition: .4s; -} - -input:checked + .slider { - background-color: #337ab7; -} - -input:focus + .slider { - box-shadow: 0 0 1px #337ab7; -} - -input:checked + .slider:before { - -webkit-transform: translateX(19px); - -ms-transform: translateX(19px); - transform: translateX(19px); -} - -/* Rounded sliders */ -.slider.round { - border-radius: 20px; -} - -.slider.round:before { - border-radius: 50%; -} -.toggle-mode .icon { - display: inline-block; -} - -.toggle-mode .icon i { - font-style: normal; - font-size: 17px; - display: inline-block; - padding-right: 7px; - padding-left: 7px; - vertical-align: middle; -} - -@media (min-width: 1600px) { - .container { - width: 1500px; - } - - .sidefilter { - width: 350px; - } - .sidetoc { - width: 350px; - } - .article.grid-right { - margin-left: 370px; - } - .sideaffix { - width: 200px; - } - .affix ul>li.active>a { - white-space: initial; - } - .affix ul>li>a { - width: 99%; - overflow: hidden; - white-space: nowrap; - text-overflow: ellipsis; - } -} \ No newline at end of file diff --git a/docfx/templates/darkfx/styles/toggle-theme.js b/docfx/templates/darkfx/styles/toggle-theme.js deleted file mode 100644 index f2ea5f5f..00000000 --- a/docfx/templates/darkfx/styles/toggle-theme.js +++ /dev/null @@ -1,35 +0,0 @@ -const sw = document.getElementById("switch-style"), sw_mobile = document.getElementById("switch-style-m"), b = document.body; -if (b) { - function toggleTheme(target, dark) { - target.classList.toggle("dark-theme", dark) - target.classList.toggle("light-theme", !dark) - } - - function switchEventListener() { - toggleTheme(b, this.checked); - if (window.localStorage) { - this.checked ? localStorage.setItem("theme", "dark-theme") : localStorage.setItem("theme", "light-theme") - } - } - - var isDarkTheme = !window.localStorage || !window.localStorage.getItem("theme") || window.localStorage && localStorage.getItem("theme") === "dark-theme"; - - if(sw && sw_mobile){ - sw.checked = isDarkTheme; - sw_mobile.checked = isDarkTheme; - - sw.addEventListener("change", switchEventListener); - sw_mobile.addEventListener("change", switchEventListener); - - // sync state between switches - sw.addEventListener("change", function() { - sw_mobile.checked = this.checked; - }); - - sw_mobile.addEventListener("change", function() { - sw.checked = this.checked; - }); - } - - toggleTheme(b, isDarkTheme); -} \ No newline at end of file diff --git a/docfx/toc.yml b/docfx/toc.yml deleted file mode 100644 index bb93c0d5..00000000 --- a/docfx/toc.yml +++ /dev/null @@ -1,8 +0,0 @@ -# - name: Examples -# href: examples/ -# homepage: examples/intro.md -- name: 🡐 return to GitHub project page - href: https://github.com/textkernel/tx-dotnet/ -- name: SDK Documentation - href: sdk/ - homepage: sdk/index.md