{"id":44121,"date":"2019-05-09T12:41:06","date_gmt":"2019-05-09T19:41:06","guid":{"rendered":"http:\/\/devblogs.microsoft.com\/xamarin\/?p=44121"},"modified":"2019-08-30T08:31:12","modified_gmt":"2019-08-30T15:31:12","slug":"xamarin-api-docs-open-source-available-now","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/xamarin\/xamarin-api-docs-open-source-available-now\/","title":{"rendered":"Xamarin API Docs: Open Sourced and Available Now"},"content":{"rendered":"<p>Today, we are happy to announce the release of all Xamarin API Documentation as Open Source! API documentation drives the IntelliSense experience while being one of the best ways to help developers achieve their goals.<\/p>\n<h3>Xamarin API Docs<\/h3>\n<p>Additionally, we have also moved the hosting of\u00a0the following from their old Xamarin home to docs.microsoft.com:<\/p>\n<ul>\n<li><a href=\"https:\/\/docs.microsoft.com\/en-us\/dotnet\/api\/?view=xamarin-forms&amp;WT.mc_id=docs-xamarinblog-jamont\">Xamarin.Forms<\/a><\/li>\n<li><a href=\"https:\/\/docs.microsoft.com\/en-us\/dotnet\/api\/?view=xamarinandroide-7.1&amp;WT.mc_id=docs-xamarinblog-jamont\">Xamarin.Android<\/a><\/li>\n<li><a href=\"https:\/\/docs.microsoft.com\/en-us\/dotnet\/api\/?view=xamarin-ios-sdk-12&amp;WT.mc_id=docs-xamarinblog-jamont\">Xamarin.iOS &amp; Xamarin.Mac<\/a><\/li>\n<li><a href=\"https:\/\/docs.microsoft.com\/en-us\/dotnet\/api\/skiasharp?view=skiasharp-1.60.3&amp;WT.mc_id=docs-xamarinblog-jamont\">SkiaSharp<\/a><\/li>\n<\/ul>\n<h3>New Documentation Site<\/h3>\n<p>The docs.microsoft.com site delivers the same presentation, search, browsing, localization, and versioning experience used across Microsoft\u2019s .NET platform. Now, you can filter by platform and version, all while getting rapid and accurate search results for namespaces, class names, and member signatures.<\/p>\n<p><figure id=\"attachment_44138\" aria-labelledby=\"figcaption_attachment_44138\" class=\"wp-caption aligncenter\" ><img decoding=\"async\" class=\"wp-image-44138 size-large\" src=\"http:\/\/devblogs.microsoft.com\/xamarin\/wp-content\/uploads\/sites\/44\/2019\/05\/xamarinformsapis-on-dmc-1024x775.png\" alt=\"Screenshot showing Xamarin.Forms API docs on docs.microsoft.com \" width=\"640\" height=\"484\" srcset=\"https:\/\/devblogs.microsoft.com\/xamarin\/wp-content\/uploads\/sites\/44\/2019\/05\/xamarinformsapis-on-dmc-1024x775.png 1024w, https:\/\/devblogs.microsoft.com\/xamarin\/wp-content\/uploads\/sites\/44\/2019\/05\/xamarinformsapis-on-dmc-300x227.png 300w, https:\/\/devblogs.microsoft.com\/xamarin\/wp-content\/uploads\/sites\/44\/2019\/05\/xamarinformsapis-on-dmc-768x581.png 768w\" sizes=\"(max-width: 640px) 100vw, 640px\" \/><figcaption id=\"figcaption_attachment_44138\" class=\"wp-caption-text\">Xamarin API Docs now Open Source<\/figcaption><\/figure><\/p>\n<h3>GitHub Repos<\/h3>\n<p>There are separate Github repos for:<\/p>\n<ul>\n<li><a href=\"https:\/\/github.com\/xamarin\/Xamarin.Forms-api-docs\">Xamarin.Forms API Docs<\/a><\/li>\n<li><a href=\"https:\/\/github.com\/xamarin\/android-api-docs\">Xamarin.Android API Docs<\/a><\/li>\n<li><a href=\"https:\/\/github.com\/xamarin\/apple-api-docs\">Xamarin\u2019s API Docs for iOS and Mac<\/a><\/li>\n<li><a href=\"https:\/\/github.com\/mono\/skiasharp-api-docs\">SkiaSharp API Docs<\/a><\/li>\n<\/ul>\n<p>The API documentation is released under <a href=\"https:\/\/creativecommons.org\/licenses\/by\/4.0\/\">Creative Commons Attribution 4.0 License<\/a> and any related source code under <a href=\"https:\/\/opensource.org\/licenses\/MIT\">the MIT License<\/a>. The Github repos are subject to <a href=\"https:\/\/opensource.microsoft.com\/codeofconduct\/\">Microsoft\u2019s Open Source Code of Conduct<\/a>. Xamarin.Android API documentation pages are modifications based on work created and <a href=\"https:\/\/developers.google.com\/terms\/site-policies\">shared by the Android Open Source Project<\/a> and used according to terms described in the <a href=\"http:\/\/creativecommons.org\/licenses\/by\/2.5\/\">Creative Commons 2.5 Attribution License<\/a>.<\/p>\n<h3>Built with Mono<\/h3>\n<p>Xamarin API documentation is built with the mono project\u2019s open-source <a href=\"https:\/\/github.com\/mono\/api-doc-tools\">mdoc<\/a> toolchain. This toolchain converts inline code comments into a dedicated directory of XML documentation files. When you update your source assembly, added\/removed classes and members are synced to the documentation repo. With this tool, you can neatly separate engineering and documentation concerns.<\/p>\n<h3>Contribute<\/h3>\n<p>Help contribute to the Xamarin API docs, or use the mdoc toolchain in your own project today! Edit the XML directly or use the <a href=\"https:\/\/github.com\/xamarin\/DocWriter\">DocWriter<\/a> tool to avoid the <a href=\"http:\/\/docs.go-mono.com\/index.aspx?link=man:mdoc(5)\">complexity of the XML format<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Today, we are happy to announce the release of all Xamarin API documentation as Open Source. Additionally, we have moved the hosting of Xamarin.Forms, Xamarin.Android, Xamarin.iOS &#038; Xamarin.Mac, and SkiaSharp from their old Xamarin home to docs.microsoft.com.<\/p>\n","protected":false},"author":556,"featured_media":39167,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[5216,2,291],"tags":[5,11,6,3616,4,16],"class_list":["post-44121","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-announcements","category-developers","category-xamarin-platform","tag-android","tag-education","tag-ios","tag-macos","tag-xamarin-platform","tag-xamarin-forms"],"acf":[],"blog_post_summary":"<p>Today, we are happy to announce the release of all Xamarin API documentation as Open Source. Additionally, we have moved the hosting of Xamarin.Forms, Xamarin.Android, Xamarin.iOS &#038; Xamarin.Mac, and SkiaSharp from their old Xamarin home to docs.microsoft.com.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/posts\/44121","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/users\/556"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/comments?post=44121"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/posts\/44121\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/media\/39167"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/media?parent=44121"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/categories?post=44121"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/xamarin\/wp-json\/wp\/v2\/tags?post=44121"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}