cypress-io · chrisbreiding · Sep 13, 2018 · Sep 13, 2018 · Sep 17, 2018 · Sep 17, 2018
diff --git a/_config.yml b/_config.yml
@@ -137,6 +137,12 @@ alias:
 
   continuous-integration.html: guides/guides/continuous-integration.html
 
+  guides/tooling/plugins-guide.html: guides/tooling/background-process.html
+  api/plugins/writing-a-plugin.html: guides/tooling/background-process.html
+  api/plugins/configuration-api.html: api/events/configuration-event.html
+  api/plugins/preprocessors-api.html: api/events/browser-filepreprocessor-event.html
+  api/plugins/browser-launch-api.html: api/events/browser-launch-event.html
+  api/plugins/after-screenshot-api.html: api/events/after-screenshot-event.html
 
 # Include/Exclude Files/Folders
 include:

diff --git a/cypress/integration/api_spec.js b/cypress/integration/api_spec.js
@@ -5,19 +5,15 @@ import { improveUrl } from '../support/repo'
 const API_PATH = '/api/api/table-of-contents'
 const API_HTML = `${API_PATH}.html`
 
-const FIRST_PAGE = 'table-of-contents.html'
-const NEXT_PAGE = 'catalog-of-events.html'
-const PAGE = '/api/events/catalog-of-events.html'
-
 describe('API', () => {
   context('Catalog of events', () => {
     beforeEach(() => {
-      cy.visit(PAGE)
+      cy.visit('/api/events/all-events.html')
     })
 
     it('loads catalog of events', () =>
       cy.get('.article-title')
-      .contains('Catalog of Events')
+      .contains('All Events')
     )
   })
 
@@ -178,11 +174,15 @@ describe('API', () => {
   })
 
   context('Pagination', () => {
+    const FIRST_PAGE = 'api/commands/and.html'
+    const NEXT_PAGE = 'api/commands/as.html'
+
     beforeEach(() => {
-      cy.visit(`${API_PATH}.html`)
+      cy.visit(FIRST_PAGE)
     })
 
     it('does not display Prev link on first page', () => {
+      cy.visit('api/api/table-of-contents.html')
       cy.get('.article-footer-prev')
       .should('not.exist')
     })

diff --git a/lib/tags/html.js b/lib/tags/html.js
@@ -0,0 +1,14 @@
+function wrapStart (hexo, args) {
+  const [className, tag] = args
+  return `<${tag || 'div'} class="${className}">`
+}
+
+function wrapEnd (hexo, args) {
+  const [tag] = args
+  return `</${tag || 'div'}>`
+}
+
+module.exports = {
+  wrapStart,
+  wrapEnd,
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/scripts/helpers.js b/scripts/helpers.js
@@ -63,7 +63,8 @@ hexo.extend.helper.register('doc_sidebar', function (className) {
 
   // IF the sidebar's categories aren't that many,
   // just expand them all, since it's more of a hassle to expand one by one
-  if (_.keys(sidebar).length <= 6) {
+  // but don't expand all for the API since it has a lot of pages
+  if (_.keys(sidebar).length <= 6 && type !== 'api') {
     expandAll = true
   }
 

diff --git a/scripts/tags.js b/scripts/tags.js
@@ -4,6 +4,7 @@
 const _ = require('lodash')
 const Promise = require('bluebird')
 const beepAndLog = require('../lib/beep')
+const { wrapStart, wrapEnd } = require('../lib/tags/html')
 const partial = require('../lib/tags/partial')
 const note = require('../lib/tags/note')
 const yields = require('../lib/tags/yields')
@@ -21,6 +22,10 @@ const history = require('../lib/tags/history')
 const aliases = require('../lib/tags/aliases')
 
 const tags = {
+  // html
+  wrap_start: wrapStart,
+  wrap_end: wrapEnd,
+
   // partials
   partial: partial,
 

diff --git a/source/_changelogs/0.20.0.md b/source/_changelogs/0.20.0.md
@@ -58,16 +58,16 @@
 - We've added a new {% url "`Cypress.Commands`" custom-commands %} interface to handle adding your own custom commands. Fixes {% issue 436 %}.
 - You can now overwrite existing commands with {% url "`Cypress.Commands.overwrite`" custom-commands %}. <OPEN A NEW ISSUE>
 - We removed an artificial delay that was being set in between commands. This means test commands now run faster.
-- You can now {% url "disable Cypress global exception handlers" catalog-of-events %} for your application. Fixes {% issue 254 %}
+- You can now {% url "disable Cypress global exception handlers" all-events %} for your application. Fixes {% issue 254 %}
 - Uncaught errors appearing in your spec files or support files are now properly caught, have the right exit code, and display correctly. Fixes {% issue 345 %}
 - Cypress will now scroll past multiple elements that cover up an element to be interacted with. It also now factors in elements with `position: sticky`. Fixes {% issue 571 %} and {% issue 565 %}.
 - Cypress now scrolls all parent containers (not just `window`) when attempting to {% url "check an element's actionability" interacting-with-elements#Actionability %}. Fixes {% issue 569 %}.
 - Using {% url "Chai.js's `assert` interface" assertions#TDD-Assertions %}  now works correctly in your specs. <OPEN AN ISSUE>
 - Screenshots are now taken during each runnable that fails. Errors in tests will happen there. Errors in hooks will also happen there. Previously a screenshot would only happen after everything (including hooks) ran. Fixes {% issue 394 %}
 - {% url "`cy.screenshot()`" screenshot %} now synchronizes its state with the reporter. This means you should see error messages (on the left side) on automatic screenshot errors.
 - Using mocha's async `done` callback now works properly.
-- You can now programmatically {% url "intercept and potentially turn off uncaught application errors" catalog-of-events %} from failing your tests.
-- You can now programmatically control whether you accept or cancel {% url "`window.confirm()`" catalog-of-events %} calls from your application.
+- You can now programmatically {% url "intercept and potentially turn off uncaught application errors" all-events %} from failing your tests.
+- You can now programmatically control whether you accept or cancel {% url "`window.confirm()`" all-events %} calls from your application.
 
 **Dependencies:**
 
@@ -158,7 +158,7 @@
 
 Note: we are still updating all of the docs to reflect all the 0.20.0 changes.
 
-- {% url 'New "Catalog of Events"' catalog-of-events %}
+- {% url 'New "Catalog of Events"' all-events %}
 - {% url 'New "Cypress.Commands"' custom-commands %}
 - {% url 'New "Cypress.log"' cypress-log %}
 - {% url 'New ".trigger()"' trigger %}
@@ -171,4 +171,3 @@ Note: we are still updating all of the docs to reflect all the 0.20.0 changes.
 - {% url 'Updated "Debugging"' debugging %}
 - {% url 'Updated "Assertions"' assertions %}
 - {% url 'Updated "Interacting with Elements"' interacting-with-elements %}
-
diff --git a/source/_changelogs/1.0.2.md b/source/_changelogs/1.0.2.md
@@ -15,6 +15,5 @@
 
 **Documentation Changes:**
 
-- {% url 'Added examples for "Catalog of Events"' catalog-of-events %}
+- {% url 'Added examples for "Catalog of Events"' all-events %}
 - {% url 'Added / Updated FAQ for "Using Cypress"' using-cypress-faq %}
-
diff --git a/source/_changelogs/3.0.2.md b/source/_changelogs/3.0.2.md
@@ -45,7 +45,7 @@
 - We now append `(failed)` to the screenshot filename of screenshots taken automatically during test failure. Fixes {% issue 1923 %}.
 - If multiple screenshots are taken during a test that will result in the same filename, their file paths are now appended with a number, i.e. `test name (1).png`. This prevents screenshot files with the same name from being overwritten. Fixes {% issue 1766 %}.
 - Screenshot `onAfterScreenshot` and `onBeforeScreenshot` callbacks ar enow invoked for failed tests. They include a `testFailure` property to distinguish between automatic ones and your own use of `cy.screenshot()`. Fixes {% issue 2040 %}.
-- There's now an {% url "`after:screenshot` plugin event" after-screenshot-api %} you can use in your `pluginsFile` to work with screenshots after they are taken. This enables you to rename them, move their location, resize them, send them to a service, etc. Fixes {% issue 2039 %}.
+- There's now an {% url "`after:screenshot` plugin event" after-screenshot-event %} you can use in your `pluginsFile` to work with screenshots after they are taken. This enables you to rename them, move their location, resize them, send them to a service, etc. Fixes {% issue 2039 %}.
 - Added `Cypress.browser` object which contains information about the currently running browser. Fixes {% issue 1919 %} and {% issue 1961 %}.
 - Added `Cypress.spec` object which contains information about the currently running spec. Fixes {% issue 1918 %}.
 - Urls displayed in the Command Log during {% url "`cy.visit()`" visit %} are no longer arbitrarily truncated at a set width. Fixes {% issue 1995 %}.
@@ -56,5 +56,4 @@
 - {% url 'Updated "Command Line" doc to include new cache commands' command-line %}
 - {% url 'Added `Cypress.browser` doc.' browser %}
 - {% url 'Added `Cypress.spec` doc.' spec %}
-- {% url 'Added `after:screenshot` plugin event doc.' after-screenshot-api %}
-
+- {% url 'Added `after:screenshot` plugin event doc.' after-screenshot-event %}
diff --git a/source/_data/sidebar.yml b/source/_data/sidebar.yml
@@ -30,7 +30,7 @@ guides:
     web-security: web-security.html
   tooling:
     intelligent-code-completion: intelligent-code-completion.html
-    plugins-guide: plugins-guide.html
+    background-process: background-process.html
     reporters: reporters.html
     typescript-support: typescript-support.html
 
@@ -52,13 +52,12 @@ guides:
     trade-offs: trade-offs.html
     # contributing: contributing.html
     changelog: changelog.html
+    migration-guide: migration-guide.html
     roadmap: roadmap.html
 
 api:
   api:
     table-of-contents: table-of-contents.html
-  events:
-    catalog-of-events: catalog-of-events.html
   assertions:
     all-assertions: assertions.html
   commands:
@@ -149,6 +148,35 @@ api:
     minimatch: minimatch.html
     moment: moment.html
     promise: promise.html
+  events:
+    all-events: all-events.html
+    browser-filepreprocessor-event: browser-filepreprocessor-event.html
+    browser-launch-event: browser-launch-event.html
+    configuration-event: configuration-event.html
+    internal-commandend-event: internal-commandend-event.html
+    internal-commandenqueue-event: internal-commandenqueue-event.html
+    internal-commandretry-event: internal-commandretry-event.html
+    internal-commandstart-event: internal-commandstart-event.html
+    internal-log-event: internal-log-event.html
+    internal-logchange-event: internal-logchange-event.html
+    page-alert-event: page-alert-event.html
+    page-confirm-event: page-confirm-event.html
+    page-end-event: page-end-event.html
+    page-ready-event: page-ready-event.html
+    page-start-event: page-start-event.html
+    page-urlchange-event: page-urlchange-event.html
+    run-end-event: run-end-event.html
+    run-start-event: run-start-event.html
+    screenshot-event: screenshot-event.html
+    scrolled-event: scrolled-event.html
+    spec-end-event: spec-end-event.html
+    spec-start-event: spec-start-event.html
+    task-event: task-event.html
+    test-end-event: test-end-event.html
+    test-fail-event: test-fail-event.html
+    test-start-event: test-start-event.html
+    uncaught-exception-event: uncaught-exception-event.html
+    viewport-change-event: viewport-change-event.html
   cypress-api:
     custom-commands: custom-commands.html
     cookies: cookies.html
@@ -164,12 +192,6 @@ api:
     platform: platform.html
     spec: spec.html
     version: version.html
-  plugins:
-    writing-a-plugin: writing-a-plugin.html
-    configuration-api: configuration-api.html
-    preprocessors-api: preprocessors-api.html
-    browser-launch-api: browser-launch-api.html
-    after-screenshot-api: after-screenshot-api.html
 
 plugins:
   plugins: index.html

diff --git a/source/api/commands/screenshot.md b/source/api/commands/screenshot.md
@@ -1,6 +1,5 @@
 ---
 title: screenshot
-
 ---
 
 Take a screenshot of the application under test and, optionally, the {% url "Cypress Command Log" test-runner#Command-Log %}.
@@ -42,15 +41,15 @@ Pass in an options object to change the default behavior of `.screenshot()`.
 
 Option |Default | Description
 --- | --- | ---
-`log` | `true` | {% usage_options log %}
 `blackout` | `[]` | Array of string selectors used to match elements that should be blacked out when the screenshot is taken. Does not apply to `runner` captures.
 `capture` | `'fullPage'` | Which parts of the Test Runner to capture. This value is ignored for element screenshot captures. Valid values are `viewport`, `fullPage`, or `runner`. When `viewport`, the application under test is captured in the current viewport. When `fullPage`, the application under test is captured in its entirety from top to bottom. When `runner`, the entire browser viewport, including the Cypress Command Log, is captured.  For screenshots automatically taken on test failure, capture is always coerced to `runner`.
 `clip` | `null` | Position and dimensions (in pixels) used to crop the final screenshot image. Should have the following shape: `{ x: 0, y: 0, width: 100, height: 100 }`
 `disableTimersAndAnimations` | `true`| When true, prevents JavaScript timers (`setTimeout`, `setInterval`, etc) and CSS animations from running while the screenshot is taken.
-`scale` | `false` | Whether to scale the app to fit into the browser viewport. This is always coerced to `true` when `capture` is `runner`.
-`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout .screenshot %}
+`log` | `true` | {% usage_options log %}
 `onBeforeScreenshot` | `null` | A callback before a (non-failure) screenshot is taken. For an element capture, the argument is the element being captured. For other screenshots, the argument is the `$el`.
 `onAfterScreenshot` | `null` | A callback after a (non-failure) screenshot is taken. For an element capture, the first argument is the element being captured. For other screenshots, the first argument is the `$el`. The second argument is properties concerning the screenshot, including the path it was saved to and the dimensions of the saved screenshot.
+`scale` | `false` | Whether to scale the app to fit into the browser viewport. This is always coerced to `true` when `capture` is `runner`.
+`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout .screenshot %}
 
 For more details on these options and to set some as defaults across all uses of `.screenshot()`, see the {% url 'Cypress.Screenshot API doc' screenshot-api %}.
 
@@ -174,9 +173,9 @@ describe('my tests', function () {
 })
 ```
 
-## `after:screenshot` plugin event
+## `screenshot` background event
 
-You can get details about any given screenshot and manipulate it after it has been written to disk with the {% url '`after:screenshot` plugin event' after-screenshot-api %}.
+You can get details about any given screenshot and manipulate it after it has been written to disk with the {% url '`screenshot` background event' screenshot-event %}.
 
 ## Test Failures
 
@@ -247,7 +246,7 @@ When clicking on `screenshot` within the command log, the console outputs the fo
 # See also
 
 - {% url `Cypress.Screenshot` screenshot-api %}
-- {% url 'After Screenshot API' after-screenshot-api %}
+- {% url '`screenshot`' screenshot-event %}
 - {% url `cy.debug()` debug %}
 - {% url 'Dashboard Service' dashboard-service %}
 - {% url 'Screenshots and Videos' screenshots-and-videos %}