- 
-
- 
- 
Slate helps you create beautiful, intelligent, responsive API documentation.
- -
The example above was created with Slate. Check it out at slatedocs.github.io/slate.
- -Features ------------- - -* **Clean, intuitive design** — With Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by [Stripe's](https://stripe.com/docs/api) and [PayPal's](https://developer.paypal.com/webapps/developer/docs/api/) API docs. Slate is responsive, so it looks great on tablets, phones, and even in print. - -* **Everything on a single page** — Gone are the days when your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy. - -* **Slate is just Markdown** — When you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks. - -* **Write code samples in multiple languages** — If your API has bindings in multiple programming languages, you can easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with GitHub Flavored Markdown. - -* **Out-of-the-box syntax highlighting** for [over 100 languages](https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers), no configuration required. - -* **Automatic, smoothly scrolling table of contents** on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents. - -* **Let your users update your documentation for you** — By default, your Slate-generated documentation is hosted in a public GitHub repository. Not only does this mean you get free hosting for your docs with GitHub Pages, but it also makes it simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to use GitHub, you're also welcome to host your docs elsewhere. - -* **RTL Support** Full right-to-left layout for RTL languages such as Arabic, Persian (Farsi), Hebrew etc. - -Getting started with Slate is super easy! Simply press the green "use this template" button above and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](https://slatedocs.github.io/slate/). - -Getting Started with Slate ------------------------------- - -To get started with Slate, please check out the [Getting Started](https://github.com/slatedocs/slate/wiki#getting-started) -section in our [wiki](https://github.com/slatedocs/slate/wiki). - -We support running Slate in three different ways: -* [Natively](https://github.com/slatedocs/slate/wiki/Using-Slate-Natively) -* [Using Vagrant](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Vagrant) -* [Using Docker](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Docker) - -Companies Using Slate ---------------------------------- - -* [NASA](https://api.nasa.gov) -* [Sony](http://developers.cimediacloud.com) -* [Best Buy](https://bestbuyapis.github.io/api-documentation/) -* [Travis-CI](https://docs.travis-ci.com/api/) -* [Greenhouse](https://developers.greenhouse.io/harvest.html) -* [WooCommerce](http://woocommerce.github.io/woocommerce-rest-api-docs/) -* [Dwolla](https://docs.dwolla.com/) -* [Clearbit](https://clearbit.com/docs) -* [Coinbase](https://developers.coinbase.com/api) -* [Parrot Drones](http://developer.parrot.com/docs/bebop/) -* [CoinAPI](https://docs.coinapi.io/) - -You can view more in [the list on the wiki](https://github.com/slatedocs/slate/wiki/Slate-in-the-Wild). - -Questions? Need Help? Found a bug? --------------------- - -If you've got questions about setup, deploying, special feature implementation in your fork, or just want to chat with the developer, please feel free to [start a thread in our Discussions tab](https://github.com/slatedocs/slate/discussions)! - -Found a bug with upstream Slate? Go ahead and [submit an issue](https://github.com/slatedocs/slate/issues). And, of course, feel free to submit pull requests with bug fixes or changes to the `dev` branch. - -Contributors --------------------- - -Slate was built by [Robert Lord](https://lord.io) while at [TripIt](https://www.tripit.com/). The project is now maintained by [Matthew Peveler](https://github.com/MasterOdin) and [Mike Ralphson](https://github.com/MikeRalphson). - -Thanks to the following people who have submitted major pull requests: - -- [@chrissrogers](https://github.com/chrissrogers) -- [@bootstraponline](https://github.com/bootstraponline) -- [@realityking](https://github.com/realityking) -- [@cvkef](https://github.com/cvkef) - -Also, thanks to [Sauce Labs](http://saucelabs.com) for sponsoring the development of the responsive styles. diff --git a/samples/rest-notes-slate/slate/Vagrantfile b/samples/rest-notes-slate/slate/Vagrantfile deleted file mode 100644 index 769b8a5b..00000000 --- a/samples/rest-notes-slate/slate/Vagrantfile +++ /dev/null @@ -1,47 +0,0 @@ -Vagrant.configure(2) do |config| - config.vm.box = "ubuntu/focal64" - config.vm.network :forwarded_port, guest: 4567, host: 4567 - config.vm.provider "virtualbox" do |vb| - vb.memory = "2048" - end - - config.vm.provision "bootstrap", - type: "shell", - inline: <<-SHELL - # add nodejs v12 repository - curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - - - sudo apt-get update - sudo apt-get install -yq ruby ruby-dev - sudo apt-get install -yq pkg-config build-essential nodejs git libxml2-dev libxslt-dev - sudo apt-get autoremove -yq - gem install --no-ri --no-rdoc bundler - SHELL - - # add the local user git config to the vm - config.vm.provision "file", source: "~/.gitconfig", destination: ".gitconfig" - - config.vm.provision "install", - type: "shell", - privileged: false, - inline: <<-SHELL - echo "==============================================" - echo "Installing app dependencies" - cd /vagrant - sudo gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)" - bundle config build.nokogiri --use-system-libraries - bundle install - SHELL - - config.vm.provision "run", - type: "shell", - privileged: false, - run: "always", - inline: <<-SHELL - echo "==============================================" - echo "Starting up middleman at http://localhost:4567" - echo "If it does not come up, check the ~/middleman.log file for any error messages" - cd /vagrant - bundle exec middleman server --watcher-force-polling --watcher-latency=1 &> ~/middleman.log & - SHELL -end diff --git a/samples/rest-notes-slate/slate/config.rb b/samples/rest-notes-slate/slate/config.rb deleted file mode 100644 index 6f8b677f..00000000 --- a/samples/rest-notes-slate/slate/config.rb +++ /dev/null @@ -1,63 +0,0 @@ -# Unique header generation -require './lib/unique_head.rb' - -# Markdown -set :markdown_engine, :redcarpet -set :markdown, - fenced_code_blocks: true, - smartypants: true, - disable_indented_code_blocks: true, - prettify: true, - strikethrough: true, - tables: true, - with_toc_data: true, - no_intra_emphasis: true, - renderer: UniqueHeadCounter - -# Assets -set :css_dir, 'stylesheets' -set :js_dir, 'javascripts' -set :images_dir, 'images' -set :fonts_dir, 'fonts' - -# Activate the syntax highlighter -activate :syntax -ready do - require './lib/monokai_sublime_slate.rb' - require './lib/multilang.rb' -end - -activate :sprockets - -activate :autoprefixer do |config| - config.browsers = ['last 2 version', 'Firefox ESR'] - config.cascade = false - config.inline = true -end - -# Github pages require relative links -activate :relative_assets -set :relative_links, true - -# Build Configuration -configure :build do - # We do want to hash woff and woff2 as there's a bug where woff2 will use - # woff asset hash which breaks things. Trying to use a combination of ignore and - # rewrite_ignore does not work as it conflicts weirdly with relative_assets. Disabling - # the .woff2 extension only does not work as .woff will still activate it so have to - # have both. See https://github.com/slatedocs/slate/issues/1171 for more details. - activate :asset_hash, :exts => app.config[:asset_extensions] - %w[.woff .woff2] - # If you're having trouble with Middleman hanging, commenting - # out the following two lines has been known to help - activate :minify_css - activate :minify_javascript - # activate :gzip -end - -# Deploy Configuration -# If you want Middleman to listen on a different port, you can set that below -set :port, 4567 - -helpers do - require './lib/toc_data.rb' -end diff --git a/samples/rest-notes-slate/slate/deploy.sh b/samples/rest-notes-slate/slate/deploy.sh deleted file mode 100755 index 9dbd7db9..00000000 --- a/samples/rest-notes-slate/slate/deploy.sh +++ /dev/null @@ -1,226 +0,0 @@ -#!/usr/bin/env bash -set -o errexit #abort if any command fails -me=$(basename "$0") - -help_message="\ -Usage: $me [-c FILE] [- s selected by tocListSelector
- // .active-expanded is applied to the ToC links that are parents of this one
- $toc.find(".active").removeClass("active");
- $toc.find(".active-parent").removeClass("active-parent");
- $best.addClass("active");
- $best.parents(tocListSelector).addClass("active").siblings(tocLinkSelector).addClass('active-parent');
- $best.siblings(tocListSelector).addClass("active");
- $toc.find(tocListSelector).filter(":not(.active)").slideUp(150);
- $toc.find(tocListSelector).filter(".active").slideDown(150);
- if (window.history.replaceState) {
- window.history.replaceState(null, "", best);
- }
- var thisTitle = $best.data("title");
- if (thisTitle !== undefined && thisTitle.length > 0) {
- document.title = thisTitle.replace(htmlPattern, "") + " – " + originalTitle;
- } else {
- document.title = originalTitle;
- }
- }
- };
-
- var makeToc = function() {
- recacheHeights();
- refreshToc();
-
- $("#nav-button").click(function() {
- $(".toc-wrapper").toggleClass('open');
- $("#nav-button").toggleClass('open');
- return false;
- });
- $(".page-wrapper").click(closeToc);
- $(".toc-link").click(closeToc);
-
- // reload immediately after scrolling on toc click
- $toc.find(tocLinkSelector).click(function() {
- setTimeout(function() {
- refreshToc();
- }, 0);
- });
-
- $(window).scroll(debounce(refreshToc, 200));
- $(window).resize(debounce(recacheHeights, 200));
- };
-
- makeToc();
-
- window.recacheHeights = recacheHeights;
- window.refreshToc = refreshToc;
- }
-
- window.loadToc = loadToc;
-})();
diff --git a/samples/rest-notes-slate/slate/source/javascripts/lib/_energize.js b/samples/rest-notes-slate/slate/source/javascripts/lib/_energize.js
deleted file mode 100644
index 6798f3c0..00000000
--- a/samples/rest-notes-slate/slate/source/javascripts/lib/_energize.js
+++ /dev/null
@@ -1,169 +0,0 @@
-/**
- * energize.js v0.1.0
- *
- * Speeds up click events on mobile devices.
- * https://github.com/davidcalhoun/energize.js
- */
-
-(function() { // Sandbox
- /**
- * Don't add to non-touch devices, which don't need to be sped up
- */
- if(!('ontouchstart' in window)) return;
-
- var lastClick = {},
- isThresholdReached, touchstart, touchmove, touchend,
- click, closest;
-
- /**
- * isThresholdReached
- *
- * Compare touchstart with touchend xy coordinates,
- * and only fire simulated click event if the coordinates
- * are nearby. (don't want clicking to be confused with a swipe)
- */
- isThresholdReached = function(startXY, xy) {
- return Math.abs(startXY[0] - xy[0]) > 5 || Math.abs(startXY[1] - xy[1]) > 5;
- };
-
- /**
- * touchstart
- *
- * Save xy coordinates when the user starts touching the screen
- */
- touchstart = function(e) {
- this.startXY = [e.touches[0].clientX, e.touches[0].clientY];
- this.threshold = false;
- };
-
- /**
- * touchmove
- *
- * Check if the user is scrolling past the threshold.
- * Have to check here because touchend will not always fire
- * on some tested devices (Kindle Fire?)
- */
- touchmove = function(e) {
- // NOOP if the threshold has already been reached
- if(this.threshold) return false;
-
- this.threshold = isThresholdReached(this.startXY, [e.touches[0].clientX, e.touches[0].clientY]);
- };
-
- /**
- * touchend
- *
- * If the user didn't scroll past the threshold between
- * touchstart and touchend, fire a simulated click.
- *
- * (This will fire before a native click)
- */
- touchend = function(e) {
- // Don't fire a click if the user scrolled past the threshold
- if(this.threshold || isThresholdReached(this.startXY, [e.changedTouches[0].clientX, e.changedTouches[0].clientY])) {
- return;
- }
-
- /**
- * Create and fire a click event on the target element
- * https://developer.mozilla.org/en/DOM/event.initMouseEvent
- */
- var touch = e.changedTouches[0],
- evt = document.createEvent('MouseEvents');
- evt.initMouseEvent('click', true, true, window, 0, touch.screenX, touch.screenY, touch.clientX, touch.clientY, false, false, false, false, 0, null);
- evt.simulated = true; // distinguish from a normal (nonsimulated) click
- e.target.dispatchEvent(evt);
- };
-
- /**
- * click
- *
- * Because we've already fired a click event in touchend,
- * we need to listed for all native click events here
- * and suppress them as necessary.
- */
- click = function(e) {
- /**
- * Prevent ghost clicks by only allowing clicks we created
- * in the click event we fired (look for e.simulated)
- */
- var time = Date.now(),
- timeDiff = time - lastClick.time,
- x = e.clientX,
- y = e.clientY,
- xyDiff = [Math.abs(lastClick.x - x), Math.abs(lastClick.y - y)],
- target = closest(e.target, 'A') || e.target, // needed for standalone apps
- nodeName = target.nodeName,
- isLink = nodeName === 'A',
- standAlone = window.navigator.standalone && isLink && e.target.getAttribute("href");
-
- lastClick.time = time;
- lastClick.x = x;
- lastClick.y = y;
-
- /**
- * Unfortunately Android sometimes fires click events without touch events (seen on Kindle Fire),
- * so we have to add more logic to determine the time of the last click. Not perfect...
- *
- * Older, simpler check: if((!e.simulated) || standAlone)
- */
- if((!e.simulated && (timeDiff < 500 || (timeDiff < 1500 && xyDiff[0] < 50 && xyDiff[1] < 50))) || standAlone) {
- e.preventDefault();
- e.stopPropagation();
- if(!standAlone) return false;
- }
-
- /**
- * Special logic for standalone web apps
- * See http://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
- */
- if(standAlone) {
- window.location = target.getAttribute("href");
- }
-
- /**
- * Add an energize-focus class to the targeted link (mimics :focus behavior)
- * TODO: test and/or remove? Does this work?
- */
- if(!target || !target.classList) return;
- target.classList.add("energize-focus");
- window.setTimeout(function(){
- target.classList.remove("energize-focus");
- }, 150);
- };
-
- /**
- * closest
- * @param {HTMLElement} node current node to start searching from.
- * @param {string} tagName the (uppercase) name of the tag you're looking for.
- *
- * Find the closest ancestor tag of a given node.
- *
- * Starts at node and goes up the DOM tree looking for a
- * matching nodeName, continuing until hitting document.body
- */
- closest = function(node, tagName){
- var curNode = node;
-
- while(curNode !== document.body) { // go up the dom until we find the tag we're after
- if(!curNode || curNode.nodeName === tagName) { return curNode; } // found
- curNode = curNode.parentNode; // not found, so keep going up
- }
-
- return null; // not found
- };
-
- /**
- * Add all delegated event listeners
- *
- * All the events we care about bubble up to document,
- * so we can take advantage of event delegation.
- *
- * Note: no need to wait for DOMContentLoaded here
- */
- document.addEventListener('touchstart', touchstart, false);
- document.addEventListener('touchmove', touchmove, false);
- document.addEventListener('touchend', touchend, false);
- document.addEventListener('click', click, true); // TODO: why does this use capture?
-
-})();
\ No newline at end of file
diff --git a/samples/rest-notes-slate/slate/source/javascripts/lib/_imagesloaded.min.js b/samples/rest-notes-slate/slate/source/javascripts/lib/_imagesloaded.min.js
deleted file mode 100644
index e443a77d..00000000
--- a/samples/rest-notes-slate/slate/source/javascripts/lib/_imagesloaded.min.js
+++ /dev/null
@@ -1,7 +0,0 @@
-/*!
- * imagesLoaded PACKAGED v4.1.4
- * JavaScript is all like "You images are done yet or what?"
- * MIT License
- */
-
-!function(e,t){"function"==typeof define&&define.amd?define("ev-emitter/ev-emitter",t):"object"==typeof module&&module.exports?module.exports=t():e.EvEmitter=t()}("undefined"!=typeof window?window:this,function(){function e(){}var t=e.prototype;return t.on=function(e,t){if(e&&t){var i=this._events=this._events||{},n=i[e]=i[e]||[];return n.indexOf(t)==-1&&n.push(t),this}},t.once=function(e,t){if(e&&t){this.on(e,t);var i=this._onceEvents=this._onceEvents||{},n=i[e]=i[e]||{};return n[t]=!0,this}},t.off=function(e,t){var i=this._events&&this._events[e];if(i&&i.length){var n=i.indexOf(t);return n!=-1&&i.splice(n,1),this}},t.emitEvent=function(e,t){var i=this._events&&this._events[e];if(i&&i.length){i=i.slice(0),t=t||[];for(var n=this._onceEvents&&this._onceEvents[e],o=0;o