Merge branch 'master' of https://github.com/lord/slate

pdube · pdube · commit d2371a7dbc9d · 2017-08-10T11:31:46.000-04:00
# By Robert Lord (24) and others # Via Robert Lord * 'master' of https://github.com/lord/slate: (33 commits) Update_errors.md (#815) Create CODE_OF_CONDUCT.md Add a few more release notes Add 2.0.0 release notes Add note about language tabs as comment in default yaml frontmatter Fix bug with initial load of ToC always jumping to top Update Vagrant to Ruby 2.4 (#803) Add JavaScript Runtime to Readme (#796) Add configurable keypress delay before initiating search (#764) Remove old ruby from travis Fix bug where head count always got larger across reloads Solve improperly nested header problem, fixes #711 Update sponsor explanation text in readme Require Ruby 2.3.1 Update issue template again Update PR template Add new issue template Update README.md (#787) Vagrant file fix for ubuntu/trusty64 (#769) Adds unique header creation (#743) ... Conflicts: source/includes/_errors.md source/index.html.md source/javascripts/app/_lang.js source/javascripts/app/_toc.js source/layouts/layout.erb
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,9 +1,15 @@
-If this is a question or feature request, make sure to:
+<!--
+⚠️  READ THIS BEFORE SUBMITTING ⚠️
 
-- [ ] The title starts with `Question:` or `Feature:`.
+• Prefix questions and feature requests with either Question: or Feature:
+• If this is a bug report or question about an issue you're having, make sure to include the form below in your issue
+-->
 
-If this is an bug report, not a question, make sure to:
+Operating system: ✍️ TODO
+Last upstream commit (run `git log --author="Robert Lord" | head -n 1`): ✍️ TODO
+Browser version(s): ✍️ TODO
+Ruby version (run `ruby -v`):  ✍️ TODO
 
-- [ ] I'm not running Windows (which is unsupported), or if I am, I can confirm this issue appears on another platform, or Vagrant.
-- [ ] This issue appears in the latest `dev` branch.
-- [ ] I've included my browser and Ruby version in this issue.
+---
+
+✍️ TODO write your issue here
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,5 @@
-!!!!! STOP AND READ !!!!!
+<!--
+⚠️ 🚨 ⚠️  STOP AND READ THIS ⚠️ 🚨 ⚠️
 
-If the dropdown above says "base fork: lord/master", you are submitting your change to ALL USERS OF SLATE, not just your company. This is probably not what you want. Click "base fork" to change it to the right place.
-
-If you're actually trying to submit a change to upstream Slate, please submit to our dev branch, PRs sent to the master branch are generally rejected.
+👆👆 see that 'base fork' dropdown above? You should change it! The default value of "lord/slate" submits your change to ALL USERS OF SLATE, not just your company. This is PROBABLY NOT WHAT YOU WANT.
+-->
diff --git a/.travis.yml b/.travis.yml
@@ -3,7 +3,6 @@ sudo: false
 language: ruby
 
 rvm:
-  - 2.2.5
   - 2.3.3
   - 2.4.0
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # Changelog
 
+## Version 2.0.0
+
+*July 17, 2017*
+
+- All-new statically generated table of contents
+  - Should be much faster loading and scrolling for large pages
+  - Smaller Javascript file sizes
+  - Avoids the problem with the last link in the ToC not ever highlighting if the section was shorter than the page
+  - Fixes control-click not opening in a new page
+  - Automatically updates the HTML title as you scroll
+- Updated design
+  - New default colors!
+  - New spacings and sizes!
+  - System-default typefaces, just like GitHub
+- Added search input delay on large corpuses to reduce lag
+- We even bumped the major version cause hey, why not?
+- Various small bug fixes
+
+Thanks to everyone who helped debug or wrote code for this version! It was a serious community effort, and I couldn't have done it alone.
+
 ## Version 1.5.0
 
 *February 23, 2017*
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@lord.io. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,4 @@
+ruby '>=2.3.1'
 source 'https://rubygems.org'
 
 # Middleman
@@ -7,3 +8,4 @@ gem 'middleman-autoprefixer', '~> 2.7.0'
 gem "middleman-sprockets", "~> 4.1.0"
 gem 'rouge', '~> 2.0.5'
 gem 'redcarpet', '~> 3.4.0'
+gem 'nokogiri', '~> 1.6.8'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -79,7 +79,10 @@ GEM
     middleman-syntax (3.0.0)
       middleman-core (>= 3.2)
       rouge (~> 2.0)
+    mini_portile2 (2.1.0)
     minitest (5.10.1)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
     padrino-helpers (0.13.3.3)
       i18n (~> 0.6, >= 0.6.7)
       padrino-support (= 0.13.3.3)
@@ -115,8 +118,12 @@ DEPENDENCIES
   middleman-autoprefixer (~> 2.7.0)
   middleman-sprockets (~> 4.1.0)
   middleman-syntax (~> 3.0.0)
+  nokogiri (~> 1.6.8)
   redcarpet (~> 3.4.0)
   rouge (~> 2.0.5)
 
+RUBY VERSION
+   ruby 2.3.3p222
+
 BUNDLED WITH
-   1.14.3
+   1.14.5
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ Getting Started with Slate
 You're going to need:
 
  - **Linux or OS X** — Windows may work, but is unsupported.
- - **Ruby, version 2.2.5 or newer**
+ - **Ruby, version 2.3.1 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
@@ -62,13 +62,16 @@ Now that Slate is all set up on your machine, you'll probably want to learn more
 
 If you'd prefer to use Docker, instructions are available [in the wiki](https://github.com/lord/slate/wiki/Docker).
 
+### Note on JavaScript Runtime
+
+For those who don't have JavaScript runtime or are experiencing JavaScript runtime issues with ExecJS, it is recommended to add the [rubyracer gem](https://github.com/cowboyd/therubyracer) to your gemfile and run `bundle` again.
+
 Companies Using Slate
 ---------------------------------
 
 * [NASA](https://api.nasa.gov)
 * [IBM](https://docs.cloudant.com/api.html)
 * [Sony](http://developers.cimediacloud.com)
-* [Mozilla](http://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)
@@ -100,7 +103,7 @@ Thanks to the following people who have submitted major pull requests:
 - [@realityking](https://github.com/realityking)
 - [@cvkef](https://github.com/cvkef)
 
-Also, thanks to [Sauce Labs](http://saucelabs.com) for helping sponsor the project.
+Also, thanks to [Sauce Labs](http://saucelabs.com) for sponsoring the development of the responsive styles.
 
 Special Thanks
 --------------------
diff --git a/Vagrantfile b/Vagrantfile
@@ -5,10 +5,12 @@ Vagrant.configure(2) do |config|
   config.vm.provision "bootstrap",
     type: "shell",
     inline: <<-SHELL
+      sudo apt-add-repository ppa:brightbox/ruby-ng
       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 ruby2.4 ruby2.4-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
+      gem2.4 install --no-ri --no-rdoc bundler
     SHELL
 
   # add the local user git config to the vm
@@ -34,6 +36,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
+end
diff --git a/config.rb b/config.rb
@@ -1,3 +1,6 @@
+# Unique header generation
+require './lib/unique_head.rb'
+
 # Markdown
 set :markdown_engine, :redcarpet
 set :markdown,
@@ -7,7 +10,8 @@
     prettify: true,
     tables: true,
     with_toc_data: true,
-    no_intra_emphasis: true
+    no_intra_emphasis: true,
+    renderer: UniqueHeadCounter
 
 # Assets
 set :css_dir, 'stylesheets'
@@ -47,3 +51,7 @@
 # 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/lib/multilang.rb b/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/lib/toc_data.rb b/lib/toc_data.rb
@@ -0,0 +1,30 @@
+require 'nokogiri'
+
+def toc_data(page_content)
+  html_doc = Nokogiri::HTML::DocumentFragment.parse(page_content)
+
+  # get a flat list of headers
+  headers = []
+  html_doc.css('h1, h2, h3').each do |header|
+    headers.push({
+      id: header.attribute('id').to_s,
+      content: header.children,
+      level: header.name[1].to_i,
+      children: []
+    })
+  end
+
+  [3,2].each do |header_level|
+    header_to_nest = nil
+    headers = headers.reject do |header|
+      if header[:level] == header_level
+        header_to_nest[:children].push header if header_to_nest
+        true
+      else
+        header_to_nest = header if header[:level] < header_level
+        false
+      end
+    end
+  end
+  headers
+end
diff --git a/lib/unique_head.rb b/lib/unique_head.rb
@@ -0,0 +1,17 @@
+# Unique header generation
+require 'middleman-core/renderers/redcarpet'
+class UniqueHeadCounter < Middleman::Renderers::MiddlemanRedcarpetHTML
+  def initialize
+    super
+    @head_count = {}
+  end
+  def header(text, header_level)
+    friendly_text = text.parameterize
+    @head_count[friendly_text] ||= 0
+    @head_count[friendly_text] += 1
+    if @head_count[friendly_text] > 1
+      friendly_text += "-#{@head_count[friendly_text]}"
+    end
+    return "<h#{header_level} id='#{friendly_text}'>#{text}</h#{header_level}>"
+  end
+end
diff --git a/source/includes/_errors.md b/source/includes/_errors.md
@@ -0,0 +1,20 @@
+# Errors
+
+<aside class="notice">This error section is stored in a separate file in `includes/_errors.md`. Slate allows you to optionally separate out your docs into many files...just save them to the `includes` folder and add them to the top of your `index.md`'s frontmatter. Files are included in the order listed.</aside>
+
+The Kittn API uses the following error codes:
+
+
+Error Code | Meaning
+---------- | -------
+400 | Bad Request -- Your request sucks.
+401 | Unauthorized -- Your API key is wrong.
+403 | Forbidden -- The kitten requested is hidden for administrators only.
+404 | Not Found -- The specified kitten could not be found.
+405 | Method Not Allowed -- You tried to access a kitten with an invalid method.
+406 | Not Acceptable -- You requested a format that isn't json.
+410 | Gone -- The kitten requested has been removed from our servers.
+418 | I'm a teapot.
+429 | Too Many Requests -- You're requesting too many kittens! Slow down!
+500 | Internal Server Error -- We had a problem with our server. Try again later.
+503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
diff --git a/source/javascripts/all.js b/source/javascripts/all.js
@@ -1,4 +1,2 @@
-//= require ./lib/_energize
-//= require ./app/_lang
+//= require ./all_nosearch
 //= require ./app/_search
-//= require ./app/_toc
diff --git a/source/javascripts/all_nosearch.js b/source/javascripts/all_nosearch.js
@@ -1,3 +1,16 @@
 //= require ./lib/_energize
-//= require ./app/_lang
 //= require ./app/_toc
+//= require ./app/_lang
+
+$(function() {
+  loadToc($('#toc'), '.toc-link', '.toc-list-h2', 10);
+  setupLanguages($('body').data('languages'));
+  $('.content').imagesLoaded( function() {
+    window.recacheHeights();
+    window.refreshToc();
+  });
+});
+
+window.onpopstate = function() {
+  activateLanguage(getLanguageFromQueryString());
+};
diff --git a/source/javascripts/app/_lang.js b/source/javascripts/app/_lang.js
diff --git a/source/javascripts/app/_search.js b/source/javascripts/app/_search.js
diff --git a/source/javascripts/app/_toc.js b/source/javascripts/app/_toc.js
diff --git a/source/javascripts/lib/_jquery.tocify.js b/source/javascripts/lib/_jquery.tocify.js
diff --git a/source/javascripts/lib/_jquery_ui.js b/source/javascripts/lib/_jquery_ui.js
diff --git a/source/layouts/layout.erb b/source/layouts/layout.erb
diff --git a/source/stylesheets/_variables.scss b/source/stylesheets/_variables.scss
diff --git a/source/stylesheets/screen.css.scss b/source/stylesheets/screen.css.scss

-Original file line number
+Diff line change
 language: ruby
 rvm:
 -  - 2.2.5
   - 2.3.3
   - 2.4.0