- -
-
-
-
-
-
Slate helps you create beautiful, intelligent, responsive API documentation.
- -
The example above was created with Slate. Check it out at lord.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/jneen/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. - -Getting started with Slate is super easy! Simply fork this repository 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://lord.github.io/slate). - -Getting Started with Slate ------------------------------- - -### Prerequisites - -You're going to need: - - - **Linux or OS X** — Windows may work, but is unsupported. - - **Ruby, version 2.2.5 or newer** - - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal. - -### Getting Set Up - -1. Fork this repository on Github. -2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git` -3. `cd slate` -4. Initialize and start Slate. You can either do this locally, or with Vagrant: - -```shell -# either run this to run locally -bundle install -bundle exec middleman server - -# OR run this to run with vagrant -vagrant up -``` - -You can now see the docs at http://localhost:4567. Whoa! That was fast! - -Now that Slate is all set up on your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/lord/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/lord/slate/wiki/Deploying-Slate). - -If you'd prefer to use Docker, instructions are available [in the wiki](https://github.com/lord/slate/wiki/Docker). - -Companies Using Slate ---------------------------------- - -* [NASA](https://api.nasa.gov) -* [IBM](https://docs.cloudant.com/api.html) -* [Sony](https://developers.cimediacloud.com) -* [Mozilla](https://localforage.github.io/localForage/) -* [Best Buy](https://bestbuyapis.github.io/api-documentation/) -* [Travis-CI](https://docs.travis-ci.com/api/) -* [Greenhouse](https://developers.greenhouse.io/harvest.html) -* [Woocommerce](https://woocommerce.github.io/woocommerce-rest-api-docs/) -* [Appium](https://appium.io/slate/en/master) -* [Dwolla](https://docs.dwolla.com/) -* [Clearbit](https://clearbit.com/docs) -* [Coinbase](https://developers.coinbase.com/api) -* [Parrot Drones](https://developer.parrot.com/docs/bebop/) -* [Fidor Bank](https://api-docs.fidor.de) -* [Scale](https://docs.scaleapi.com/) - -You can view more in [the list on the wiki](https://github.com/lord/slate/wiki/Slate-in-the-Wild). - -Need Help? Found a bug? --------------------- - -[Submit an issue](https://github.com/lord/slate/issues) to the Slate Github if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes. - -Contributors --------------------- - -Slate was built by [Robert Lord](https://lord.io) while interning at [TripIt](https://www.tripit.com/). - -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](https://saucelabs.com) for helping sponsor the project. - -Special Thanks --------------------- -- [Middleman](https://github.com/middleman/middleman) -- [jquery.tocify.js](https://github.com/gfranko/jquery.tocify.js) -- [middleman-syntax](https://github.com/middleman/middleman-syntax) -- [middleman-gh-pages](https://github.com/edgecase/middleman-gh-pages) -- [Font Awesome](https://fortawesome.github.io/Font-Awesome/) diff --git a/samples/rest-notes-slate/slate/Vagrantfile b/samples/rest-notes-slate/slate/Vagrantfile index 43b1f995..4166fb6b 100644 --- a/samples/rest-notes-slate/slate/Vagrantfile +++ b/samples/rest-notes-slate/slate/Vagrantfile @@ -1,14 +1,21 @@ Vagrant.configure(2) do |config| - config.vm.box = "ubuntu/trusty64" + config.vm.box = "ubuntu/bionic64" 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 ruby2.0 ruby2.0-dev pkg-config build-essential nodejs git libxml2-dev libxslt-dev + 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 - gem2.0 install --no-ri --no-rdoc bundler + gem install --no-ri --no-rdoc bundler SHELL # add the local user git config to the vm @@ -34,6 +41,6 @@ Vagrant.configure(2) do |config| 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 --force-polling --latency=1 &> ~/middleman.log & + 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 index 0cb5fea4..6f8b677f 100644 --- a/samples/rest-notes-slate/slate/config.rb +++ b/samples/rest-notes-slate/slate/config.rb @@ -1,3 +1,6 @@ +# Unique header generation +require './lib/unique_head.rb' + # Markdown set :markdown_engine, :redcarpet set :markdown, @@ -5,9 +8,11 @@ set :markdown, smartypants: true, disable_indented_code_blocks: true, prettify: true, + strikethrough: true, tables: true, with_toc_data: true, - no_intra_emphasis: true + no_intra_emphasis: true, + renderer: UniqueHeadCounter # Assets set :css_dir, 'stylesheets' @@ -18,6 +23,7 @@ set :fonts_dir, 'fonts' # Activate the syntax highlighter activate :syntax ready do + require './lib/monokai_sublime_slate.rb' require './lib/multilang.rb' end @@ -34,19 +40,24 @@ activate :relative_assets set :relative_links, true # Build Configuration - -set :build_dir, '../build/docs' - 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 :relative_assets - # activate :asset_hash # 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 index 909a9d90..9dbd7db9 100755 --- a/samples/rest-notes-slate/slate/deploy.sh +++ b/samples/rest-notes-slate/slate/deploy.sh @@ -15,9 +15,14 @@ Options: deploy branch. -n, --no-hash Don't append the source commit's hash to the deploy commit's message. + --source-only Only build but not push + --push-only Only push but not build " -bundle exec middleman build --clean + +run_build() { + bundle exec middleman build --clean +} parse_args() { # Set args from a local environment file. @@ -31,7 +36,7 @@ parse_args() { while : ; do if [[ $1 = "-h" || $1 = "--help" ]]; then echo "$help_message" - return 0 + exit 0 elif [[ $1 = "-v" || $1 = "--verbose" ]]; then verbose=true shift @@ -44,11 +49,22 @@ parse_args() { elif [[ $1 = "-n" || $1 = "--no-hash" ]]; then GIT_DEPLOY_APPEND_HASH=false shift + elif [[ $1 = "--source-only" ]]; then + source_only=true + shift + elif [[ $1 = "--push-only" ]]; then + push_only=true + shift else break fi done + if [ ${source_only} ] && [ ${push_only} ]; then + >&2 echo "You can only specify one of --source-only or --push-only" + exit 1 + fi + # Set internal option vars from the environment and arg flags. All internal # vars should be declared here, with sane defaults if applicable. @@ -68,8 +84,6 @@ parse_args() { } main() { - parse_args "$@" - enable_expanded_output if ! git diff --exit-code --quiet --cached; then @@ -97,7 +111,7 @@ main() { return 1 fi - # must use short form of flag in ls for compatibility with OS X and BSD + # must use short form of flag in ls for compatibility with macOS and BSD if [[ -z `ls -A "$deploy_directory" 2> /dev/null` && -z $allow_empty ]]; then echo "Deploy directory '$deploy_directory' is empty. Aborting. If you're sure you want to deploy an empty tree, use the --allow-empty / -e flag." >&2 return 1 @@ -140,7 +154,7 @@ incremental_deploy() { 0) echo No changes to files in $deploy_directory. Skipping commit.;; 1) commit+push;; *) - echo git diff exited with code $diff. Aborting. Staying on branch $deploy_branch so you can debug. To switch back to master, use: git symbolic-ref HEAD refs/heads/master && git reset --mixed >&2 + echo git diff exited with code $diff. Aborting. Staying on branch $deploy_branch so you can debug. To switch back to main, use: git symbolic-ref HEAD refs/heads/main && git reset --mixed >&2 return $diff ;; esac @@ -200,4 +214,13 @@ sanitize() { "$@" 2> >(filter 1>&2) | filter } -[[ $1 = --source-only ]] || main "$@" +parse_args "$@" + +if [[ ${source_only} ]]; then + run_build +elif [[ ${push_only} ]]; then + main "$@" +else + run_build + main "$@" +fi diff --git a/samples/rest-notes-slate/slate/lib/monokai_sublime_slate.rb b/samples/rest-notes-slate/slate/lib/monokai_sublime_slate.rb new file mode 100644 index 00000000..cd2de331 --- /dev/null +++ b/samples/rest-notes-slate/slate/lib/monokai_sublime_slate.rb @@ -0,0 +1,95 @@ +# -*- coding: utf-8 -*- # +# frozen_string_literal: true + +# this is based on https://github.com/rouge-ruby/rouge/blob/master/lib/rouge/themes/monokai_sublime.rb +# but without the added background, and changed styling for JSON keys to be soft_yellow instead of white + +module Rouge + module Themes + class MonokaiSublimeSlate < CSSTheme + name 'monokai.sublime.slate' + + palette :black => '#000000' + palette :bright_green => '#a6e22e' + palette :bright_pink => '#f92672' + palette :carmine => '#960050' + palette :dark => '#49483e' + palette :dark_grey => '#888888' + palette :dark_red => '#aa0000' + palette :dimgrey => '#75715e' + palette :emperor => '#555555' + palette :grey => '#999999' + palette :light_grey => '#aaaaaa' + palette :light_violet => '#ae81ff' + palette :soft_cyan => '#66d9ef' + palette :soft_yellow => '#e6db74' + palette :very_dark => '#1e0010' + palette :whitish => '#f8f8f2' + palette :orange => '#f6aa11' + palette :white => '#ffffff' + + style Generic::Heading, :fg => :grey + style Literal::String::Regex, :fg => :orange + style Generic::Output, :fg => :dark_grey + style Generic::Prompt, :fg => :emperor + style Generic::Strong, :bold => false + style Generic::Subheading, :fg => :light_grey + style Name::Builtin, :fg => :orange + style Comment::Multiline, + Comment::Preproc, + Comment::Single, + Comment::Special, + Comment, :fg => :dimgrey + style Error, + Generic::Error, + Generic::Traceback, :fg => :carmine + style Generic::Deleted, + Generic::Inserted, + Generic::Emph, :fg => :dark + style Keyword::Constant, + Keyword::Declaration, + Keyword::Reserved, + Name::Constant, + Keyword::Type, :fg => :soft_cyan + style Literal::Number::Float, + Literal::Number::Hex, + Literal::Number::Integer::Long, + Literal::Number::Integer, + Literal::Number::Oct, + Literal::Number, + Literal::String::Char, + Literal::String::Escape, + Literal::String::Symbol, :fg => :light_violet + style Literal::String::Doc, + Literal::String::Double, + Literal::String::Backtick, + Literal::String::Heredoc, + Literal::String::Interpol, + Literal::String::Other, + Literal::String::Single, + Literal::String, :fg => :soft_yellow + style Name::Attribute, + Name::Class, + Name::Decorator, + Name::Exception, + Name::Function, :fg => :bright_green + style Name::Variable::Class, + Name::Namespace, + Name::Entity, + Name::Builtin::Pseudo, + Name::Variable::Global, + Name::Variable::Instance, + Name::Variable, + Text::Whitespace, + Text, + Name, :fg => :white + style Name::Label, :fg => :bright_pink + style Operator::Word, + Name::Tag, + Keyword, + Keyword::Namespace, + Keyword::Pseudo, + Operator, :fg => :bright_pink + end + end + end diff --git a/samples/rest-notes-slate/slate/lib/multilang.rb b/samples/rest-notes-slate/slate/lib/multilang.rb index 624c6e49..36fbe5b1 100644 --- a/samples/rest-notes-slate/slate/lib/multilang.rb +++ b/samples/rest-notes-slate/slate/lib/multilang.rb @@ -1,9 +1,13 @@ module Multilang def block_code(code, full_lang_name) - parts = full_lang_name.split('--') - rouge_lang_name = parts[0] || "" - super(code, rouge_lang_name).sub("highlight #{rouge_lang_name}") do |match| - match + " tab-" + full_lang_name + if full_lang_name + parts = full_lang_name.split('--') + rouge_lang_name = (parts) ? parts[0] : "" # just parts[0] here causes null ref exception when no language specified + super(code, rouge_lang_name).sub("highlight #{rouge_lang_name}") do |match| + match + " tab-" + full_lang_name + end + else + super(code, full_lang_name) end end end diff --git a/samples/rest-notes-slate/slate/lib/nesting_unique_head.rb b/samples/rest-notes-slate/slate/lib/nesting_unique_head.rb new file mode 100644 index 00000000..01278371 --- /dev/null +++ b/samples/rest-notes-slate/slate/lib/nesting_unique_head.rb @@ -0,0 +1,22 @@ +# Nested unique header generation +require 'middleman-core/renderers/redcarpet' + +class NestingUniqueHeadCounter < Middleman::Renderers::MiddlemanRedcarpetHTML + def initialize + super + @@headers_history = {} if !defined?(@@headers_history) + end + + def header(text, header_level) + friendly_text = text.gsub(/<[^>]*>/,"").parameterize + @@headers_history[header_level] = text.parameterize + + if header_level > 1 + for i in (header_level - 1).downto(1) + friendly_text.prepend("#{@@headers_history[i]}-") if @@headers_history.key?(i) + end + end + + return "