{"id":7782,"date":"2019-08-26T12:47:42","date_gmt":"2019-08-26T12:47:42","guid":{"rendered":"https:\/\/www.botreetechnologies.com\/blog\/?p=7782"},"modified":"2022-12-13T15:49:35","modified_gmt":"2022-12-13T10:19:35","slug":"create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify","status":"publish","type":"post","link":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/","title":{"rendered":"Beautiful API Documentation with Slate &#038; Host it on Netlify"},"content":{"rendered":"\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p><strong><em>&#8220;APIs can be among a company&#8217;s greatest asset, but it can also be among the company&#8217;s greatest liabilities&#8221;\u200a\u2014\u200aJoshua Bloch<\/em><\/strong><\/p><\/blockquote>\n\n\n\n<p>Having a well-designed API is not enough. It should be documented well enough to be effectively used by other developers to build interesting and innovative solutions around it.<\/p>\n\n\n\n<p>I am not going to go deeper into what are the best practices for the API documentation. Instead, I will go straight to the solution used by<a href=\"https:\/\/api.nasa.gov\" target=\"_blank\" rel=\"noopener noreferrer\"> NASA<\/a>,<a href=\"https:\/\/developers.cimediacloud.com\/\" target=\"_blank\" rel=\"noopener noreferrer\"> SONY<\/a>,<a href=\"https:\/\/bestbuyapis.github.io\/api-documentation\/\" target=\"_blank\" rel=\"noopener noreferrer\"> Best Buy<\/a>, and many<a href=\"https:\/\/github.com\/lord\/slate\/wiki\/Slate-in-the-Wild\" target=\"_blank\" rel=\"noopener noreferrer\">&nbsp;more awesome APIs<\/a>! They all are <a href=\"https:\/\/github.com\/lord\/slate\" target=\"_blank\" rel=\"noopener noreferrer\">built with Slate<\/a>.<\/p>\n\n\n\n<p>Slate helps you create beautiful, intelligent, responsive API documentation. It is<a href=\"https:\/\/github.com\/lord\/slate#features\" target=\"_blank\" rel=\"noopener noreferrer\"> feature rich<\/a> interactive documentation solution. There is a comprehensive list of things you can do with Slate and customize it as per your need. Check out the<a href=\"https:\/\/github.com\/lord\/slate\/wiki\" target=\"_blank\" rel=\"noopener noreferrer\"> wiki<\/a>.<\/p>\n\n\n\n<p>I assume you know how to document your API using markdown and middlemen backed by <a href=\"https:\/\/yourstory.com\/mystory\/what-is-github-a-beginners-guide-to-github-edkzyjjng4\" target=\"_blank\" rel=\"noopener noreferrer\">Github<\/a>. The following steps would help you to make your documented API public using amazing<a href=\"https:\/\/www.netlify.com\/\" target=\"_blank\" rel=\"noopener noreferrer\"> Netlify<\/a> for free!<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">1. Prerequisite<\/h2>\n\n\n\n<p>Slate is powered by<a href=\"https:\/\/middlemanapp.com\/\" target=\"_blank\" rel=\"noopener noreferrer\"> middlemen<\/a> which are static site generator <a href=\"https:\/\/www.botreetechnologies.com\/ruby-on-rails-development\" target=\"_blank\" rel=\"noopener noreferrer\">built on Ruby<\/a>. Checkout system requirements<a href=\"https:\/\/github.com\/lord\/slate#prerequisites\" target=\"_blank\" rel=\"noopener noreferrer\"> here<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">2. Local Setup<\/h2>\n\n\n\n<p>First fork Slate<a href=\"https:\/\/github.com\/lord\/slate\" target=\"_blank\" rel=\"noopener noreferrer\"> repository<\/a> and clone it locally. Then go to the home directory of the forked repo in command line do <code>bundle install<\/code> to install required gems. Start middlemen server by running a <code>bundle exec middleman server<\/code> from the command line.<\/p>\n\n\n\n<p>This will by default start web server backed by middleman at http:\/\/localhost:4567. Hit the URL in your browser and voila beautiful documentation pages appear.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"800\" height=\"396\" src=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/local-setup.png\" alt=\"Local Setup\" class=\"wp-image-13420\" srcset=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/local-setup.png 800w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/local-setup-300x149.png 300w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/local-setup-768x380.png 768w\" sizes=\"auto, (max-width: 800px) 100vw, 800px\" \/><\/figure>\n<\/div>\n\n\n<p>Checkout source file<a href=\"https:\/\/github.com\/lord\/slate\/blob\/master\/source\/index.html.md\" target=\"_blank\" rel=\"noopener noreferrer\"> here<\/a> for reference to compare with generated document pages. You need to<a href=\"https:\/\/github.com\/lord\/slate\/wiki\/Markdown-Syntax\" target=\"_blank\" rel=\"noopener noreferrer\"> modify as per your API need<\/a> and refresh the page to see it. Simple!<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">3. Host API documents on Netlify<\/h3>\n\n\n\n<p><a href=\"https:\/\/www.botreetechnologies.com\/blog\/jamstack-is-the-powerful-architecture-leaving-wordpress-behind\" target=\"_blank\" rel=\"noopener noreferrer\">JAMStack<\/a> has become very popular, and<a href=\"https:\/\/www.netlify.com\/\" target=\"_blank\" rel=\"noopener noreferrer\"> Netlify<\/a> is unparalleled popular among developers.<\/p>\n\n\n\n<p>Netlify is everything you need to build fast, modern websites: continuous deployment, serverless functions, and so much more<\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p>Read Also:&nbsp;<a href=\"https:\/\/www.botreetechnologies.com\/blog\/integrating-google-cloud-vision-api-with-ruby-for-image-object-detection\" target=\"_blank\" rel=\"noopener noreferrer\">Integrating Google Cloud Vision API with Ruby for Image Object Detection<\/a><\/p><\/blockquote>\n\n\n\n<h3 class=\"wp-block-heading\">Step 1: Sign In \/ Sign Up<\/h3>\n\n\n\n<p>I would recommend to sign up with Github so that you can quickly access your document repository to be hosted. The rest of this article assumes you will be using Github.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"800\" height=\"396\" src=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/sign-up-with-github.png\" alt=\"Sign up with Github\" class=\"wp-image-13421\" srcset=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/sign-up-with-github.png 800w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/sign-up-with-github-300x149.png 300w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/sign-up-with-github-768x380.png 768w\" sizes=\"auto, (max-width: 800px) 100vw, 800px\" \/><\/figure>\n<\/div>\n\n\n<h5 class=\"has-text-align-center wp-block-heading\">Select the sites to tab on Netflify Dashboard<\/h5>\n\n\n\n<h3 class=\"wp-block-heading\">Step 2: Click on \u201cNew Site From Git\u201d button<\/h3>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"800\" height=\"396\" src=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/connect-to-git-provider-wizard.png\" alt=\"Connect to Git Provider Wizard\" class=\"wp-image-13422\" srcset=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/connect-to-git-provider-wizard.png 800w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/connect-to-git-provider-wizard-300x149.png 300w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/connect-to-git-provider-wizard-768x380.png 768w\" sizes=\"auto, (max-width: 800px) 100vw, 800px\" \/><\/figure>\n<\/div>\n\n\n<h5 class=\"has-text-align-center wp-block-heading\">Connect to Git Provider Wizard<\/h5>\n\n\n\n<p>Click on the \u201cGithub\u201d button from the \u201cContinuous Deployment\u201d section.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Step 3: Search and Select your API documentation Slate repository<\/h3>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"800\" height=\"396\" src=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/pick-forked-slate-repository.png\" alt=\"Pick forked Slate Repository\" class=\"wp-image-13423\" srcset=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/pick-forked-slate-repository.png 800w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/pick-forked-slate-repository-300x149.png 300w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/pick-forked-slate-repository-768x380.png 768w\" sizes=\"auto, (max-width: 800px) 100vw, 800px\" \/><\/figure>\n<\/div>\n\n\n<h5 class=\"has-text-align-center wp-block-heading\">Pick forked Slate Repository<\/h5>\n\n\n\n<h3 class=\"wp-block-heading\">Step 4: Specify Build Settings<\/h3>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"800\" height=\"786\" src=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/build-settings-for-middleman.png\" alt=\"Build Settings for Middleman\" class=\"wp-image-13428\" srcset=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/build-settings-for-middleman.png 800w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/build-settings-for-middleman-300x295.png 300w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/build-settings-for-middleman-768x755.png 768w\" sizes=\"auto, (max-width: 800px) 100vw, 800px\" \/><figcaption><strong>Build Settings for Middleman<\/strong><\/figcaption><\/figure>\n<\/div>\n\n\n<p><\/p>\n\n\n\n<p>Select the desired branch, mention middleman build command and build directory (where static pages generated by middleman) and press the &#8220;Deploy site&#8221; button and voila!! Your site started deploying.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"768\" height=\"1024\" src=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/deploy-site.png\" alt=\"Deploy Site\" class=\"wp-image-13424\" srcset=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/deploy-site.png 768w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/deploy-site-225x300.png 225w\" sizes=\"auto, (max-width: 768px) 100vw, 768px\" \/><\/figure>\n<\/div>\n\n\n<p>Wait for a couple of minutes to finish and you then you will see your site URL<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"680\" height=\"204\" src=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/deployed-on-netlify.png\" alt=\"Deployed on Netlify\" class=\"wp-image-13425\" srcset=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/deployed-on-netlify.png 680w, https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/12\/deployed-on-netlify-300x90.png 300w\" sizes=\"auto, (max-width: 680px) 100vw, 680px\" \/><\/figure>\n<\/div>\n\n\n<p>And that&#8217;s it.<\/p>\n\n\n\n<p>If you need to change anything in the document, push it to the branch which is deployed on Netlify, and it will be updated automatically!! Amazing!!<\/p>\n\n\n\n<p><a href=\"https:\/\/www.botreetechnologies.com\/ruby-on-rails-development\" target=\"_blank\" rel=\"noopener noreferrer\"><strong>Click here for more details&#8230;<\/strong><\/a><\/p>\n\n\n\n<hr class=\"wp-block-separator has-css-opacity\"\/>\n\n\n\n<p>At <a href=\"https:\/\/www.botreetechnologies.com\/\" target=\"_blank\" rel=\"noopener noreferrer\">BoTree Technologies<\/a>, we build enterprise applications with our RoR team of 25+ engineers.<\/p>\n\n\n\n<p>We also specialize in RPA, AI, Python, Django, JavaScript and ReactJS.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><a href=\"https:\/\/www.botreetechnologies.com\/contact\" target=\"_blank\" rel=\"noopener noreferrer\">Consulting is free<\/a> &#8211; let us help you grow!<\/h3>\n","protected":false},"excerpt":{"rendered":"<p>&#8220;APIs can be among a company&#8217;s greatest asset, but it&#8230;<\/p>\n","protected":false},"author":3,"featured_media":13416,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[73,10],"tags":[],"class_list":["post-7782","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-ruby-on-rails","category-technology"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.2 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Beautiful API Documentation with Slate and Host it for Free on Netlify<\/title>\n<meta name=\"description\" content=\"Wondering how you can create beautiful, intelligent, responsive API documentation? Slate is the perfect answer for customizing the API documentation.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Beautiful API Documentation with Slate and Host it for Free on Netlify\" \/>\n<meta property=\"og:description\" content=\"Wondering how you can create beautiful, intelligent, responsive API documentation? Slate is the perfect answer for customizing the API documentation.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/\" \/>\n<meta property=\"og:site_name\" content=\"BoTree Technologies\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/BoTreeTechnologies\/\" \/>\n<meta property=\"article:published_time\" content=\"2019-08-26T12:47:42+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2022-12-13T10:19:35+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"1920\" \/>\n\t<meta property=\"og:image:height\" content=\"1280\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Amit Patel\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@BoTreeTech\" \/>\n<meta name=\"twitter:site\" content=\"@BoTreeTech\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Amit Patel\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/\"},\"author\":{\"name\":\"Amit Patel\",\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/#\/schema\/person\/86645099906a429b0c5ca4de2bf92c46\"},\"headline\":\"Beautiful API Documentation with Slate &#038; Host it on Netlify\",\"datePublished\":\"2019-08-26T12:47:42+00:00\",\"dateModified\":\"2022-12-13T10:19:35+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/\"},\"wordCount\":535,\"commentCount\":15,\"image\":{\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg\",\"articleSection\":[\"Ruby on Rails\",\"Technology\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/\",\"url\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/\",\"name\":\"Beautiful API Documentation with Slate and Host it for Free on Netlify\",\"isPartOf\":{\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg\",\"datePublished\":\"2019-08-26T12:47:42+00:00\",\"dateModified\":\"2022-12-13T10:19:35+00:00\",\"author\":{\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/#\/schema\/person\/86645099906a429b0c5ca4de2bf92c46\"},\"description\":\"Wondering how you can create beautiful, intelligent, responsive API documentation? Slate is the perfect answer for customizing the API documentation.\",\"breadcrumb\":{\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#primaryimage\",\"url\":\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg\",\"contentUrl\":\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg\",\"width\":1920,\"height\":1280,\"caption\":\"slate api documentation example\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.botreetechnologies.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Beautiful API Documentation with Slate &#038; Host it on Netlify\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/#website\",\"url\":\"https:\/\/www.botreetechnologies.com\/blog\/\",\"name\":\"BoTree Technologies\",\"description\":\"Committed to inspire generation.\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.botreetechnologies.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/#\/schema\/person\/86645099906a429b0c5ca4de2bf92c46\",\"name\":\"Amit Patel\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/10\/amit-patel-1-150x150.png\",\"url\":\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/10\/amit-patel-1-150x150.png\",\"contentUrl\":\"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/10\/amit-patel-1-150x150.png\",\"caption\":\"Amit Patel\"},\"description\":\"Amit is the COO and Co-founder of BoTree Technologies. He is a developer advocate and solution architect at the company. He has helped many SME and Large corporations digitize their business operations. He loves hanging out with friends and meditate.\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Beautiful API Documentation with Slate and Host it for Free on Netlify","description":"Wondering how you can create beautiful, intelligent, responsive API documentation? Slate is the perfect answer for customizing the API documentation.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/","og_locale":"en_US","og_type":"article","og_title":"Beautiful API Documentation with Slate and Host it for Free on Netlify","og_description":"Wondering how you can create beautiful, intelligent, responsive API documentation? Slate is the perfect answer for customizing the API documentation.","og_url":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/","og_site_name":"BoTree Technologies","article_publisher":"https:\/\/www.facebook.com\/BoTreeTechnologies\/","article_published_time":"2019-08-26T12:47:42+00:00","article_modified_time":"2022-12-13T10:19:35+00:00","og_image":[{"width":1920,"height":1280,"url":"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg","type":"image\/jpeg"}],"author":"Amit Patel","twitter_card":"summary_large_image","twitter_creator":"@BoTreeTech","twitter_site":"@BoTreeTech","twitter_misc":{"Written by":"Amit Patel","Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#article","isPartOf":{"@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/"},"author":{"name":"Amit Patel","@id":"https:\/\/www.botreetechnologies.com\/blog\/#\/schema\/person\/86645099906a429b0c5ca4de2bf92c46"},"headline":"Beautiful API Documentation with Slate &#038; Host it on Netlify","datePublished":"2019-08-26T12:47:42+00:00","dateModified":"2022-12-13T10:19:35+00:00","mainEntityOfPage":{"@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/"},"wordCount":535,"commentCount":15,"image":{"@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#primaryimage"},"thumbnailUrl":"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg","articleSection":["Ruby on Rails","Technology"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/","url":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/","name":"Beautiful API Documentation with Slate and Host it for Free on Netlify","isPartOf":{"@id":"https:\/\/www.botreetechnologies.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#primaryimage"},"image":{"@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#primaryimage"},"thumbnailUrl":"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg","datePublished":"2019-08-26T12:47:42+00:00","dateModified":"2022-12-13T10:19:35+00:00","author":{"@id":"https:\/\/www.botreetechnologies.com\/blog\/#\/schema\/person\/86645099906a429b0c5ca4de2bf92c46"},"description":"Wondering how you can create beautiful, intelligent, responsive API documentation? Slate is the perfect answer for customizing the API documentation.","breadcrumb":{"@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#primaryimage","url":"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg","contentUrl":"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2019\/08\/beautiful-api-documentation.jpg","width":1920,"height":1280,"caption":"slate api documentation example"},{"@type":"BreadcrumbList","@id":"https:\/\/www.botreetechnologies.com\/blog\/create-a-beautiful-api-documentation-with-slate-and-host-it-for-free-on-netlify\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.botreetechnologies.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Beautiful API Documentation with Slate &#038; Host it on Netlify"}]},{"@type":"WebSite","@id":"https:\/\/www.botreetechnologies.com\/blog\/#website","url":"https:\/\/www.botreetechnologies.com\/blog\/","name":"BoTree Technologies","description":"Committed to inspire generation.","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.botreetechnologies.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.botreetechnologies.com\/blog\/#\/schema\/person\/86645099906a429b0c5ca4de2bf92c46","name":"Amit Patel","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/10\/amit-patel-1-150x150.png","url":"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/10\/amit-patel-1-150x150.png","contentUrl":"https:\/\/www.botreetechnologies.com\/blog\/wp-content\/uploads\/2020\/10\/amit-patel-1-150x150.png","caption":"Amit Patel"},"description":"Amit is the COO and Co-founder of BoTree Technologies. He is a developer advocate and solution architect at the company. He has helped many SME and Large corporations digitize their business operations. He loves hanging out with friends and meditate."}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/posts\/7782","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/comments?post=7782"}],"version-history":[{"count":5,"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/posts\/7782\/revisions"}],"predecessor-version":[{"id":18246,"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/posts\/7782\/revisions\/18246"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/media\/13416"}],"wp:attachment":[{"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/media?parent=7782"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/categories?post=7782"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.botreetechnologies.com\/blog\/wp-json\/wp\/v2\/tags?post=7782"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}