_config.yml

# Hexo Configuration
## Docs: https://hexo.io/docs/configuration.html
## Source: https://github.com/hexojs/hexo/

# Site
title: Cypress Documentation
subtitle: Testing, the way it should be.
description: Cypress is a test engine that runs unit and integration tests in your browser. It makes it easy to write and debug web application tests.
author: Cypress.io

# https://hexo.io/docs/internationalization.html
language:
  - en
  - zh-cn
  - ja
  - pt-br

# URL
## If your site is put in a subdirectory, set url as 'http://yoursite.com/child' and root as '/child/'
root: /
permalink: :year/:month/:day/:title/
permalink_defaults:

logo: img/logo.png
github: cypress-io/cypress

# Directory
source_dir: source
public_dir: public
i18n_dir: :lang
skip_render:

# Generate alias pages for redirecting to posts, pages or URL
# You must run `npm run build` for changes to take effect
# https://github.com/hexojs/hexo-generator-alias
# to redirect a directory, make sure it has a trailing slash (/docs/bob > /docs/bob/)
# can also do outside page links here
# plugins/index.html: https://github.com/cypress/cypress/wiki/Plugins
alias:
  index.html: guides/overview/why-cypress.html

  guides/index.html: guides/overview/why-cypress.html
  guides.html: guides/overview/why-cypress.html
  guides/references/type/: api/commands/type.html
  guides/references/known-issues.html: 404.html
  guides/integrating-cypress/features.html: guides/guides/continuous-integration.html
  guides/network-requests-xhr/: guides/guides/network-requests.html
  guides/issuing-commands/: guides/core-concepts/introduction-to-cypress.html#Subject-Management
  guides/installing-and-running/: guides/getting-started/installing-cypress.html
  guides/core-concepts/aliases-and-references.html: guides/core-concepts/variables-and-aliases.html
  guides/core-concepts/overview-of-the-gui/: guides/core-concepts/overview-of-test-runner.html
  guides/core-concepts/overview-of-the-gui.html: guides/core-concepts/overview-of-test-runner.html
  guides/core-concepts/overview-of-test-runner.html: guides/core-concepts/test-runner.html
  guides/core-concepts/overview-of-test-runner/: guides/core-concepts/test-runner.html
  guides/core-concepts/screenshots-and-videos.html: guides/guides/screenshots-and-videos.html
  guides/guides/reporters.html: guides/tooling/reporters.html
  guides/guides/reporters/: guides/tooling/reporters.html
  overview-of-test-runner/: guides/core-concepts/test-runner.html
  why-cypress/: guides/overview/why-cypress.html

  api/index.html: api/api/table-of-contents.html
  api/commands/.html: api/api/table-of-contents.html
  api/introduction/api.html: api/api/table-of-contents.html
  api/assertions/assertions.html: guides/references/assertions.html
  api/commands/cypress-blob.html: api/utilities/blob.html
  api/commands/api-server.html: api/cypress-api/cypress-server.html

  examples/index.html: examples/examples/recipes.html

  examples/recipes/index.html: examples/examples/recipes.html
  examples/unit-testing-recipe.html: examples/examples/recipes.html
  examples/recipes/unit-testing-recipe.html: examples/examples/recipes.html
  examples/logging-in-recipe.html: examples/examples/recipes.html
  examples/recipes/logging-in-recipe.html: examples/examples/recipes.html
  examples/testing-the-dom-recipe.html: examples/examples/recipes.html
  examples/recipes/testing-the-dom-recipe.html: examples/examples/recipes.html
  examples/working-with-the-backend-recipe.html: examples/examples/recipes.html
  examples/recipes/working-with-the-backend-recipe.html: examples/examples/recipes.html
  examples/stubs-spies-and-clocks-recipe.html: examples/examples/recipes.html
  examples/recipes/stubs-spies-and-clocks-recipe.html: examples/examples/recipes.html
  examples/extending-cypress-recipe.html: examples/examples/recipes.html
  examples/recipes/extending-cypress-recipe.html: examples/examples/recipes.html

  examples/applications/kitchen-sink.html: examples/examples/applications.html
  examples/applications/todo-mvc.html: examples/examples/applications.html
  examples/applications/pie-chopper.html: examples/examples/applications.html
  examples/applications/phonecat.html: examples/examples/applications.html

  examples/docker/docker-images.html: examples/examples/docker.html
  examples/docker/circle-ci.html: examples/examples/docker.html
  examples/docker/codeship.html: examples/examples/docker.html

  examples/userland/userland-extensions.html: plugins/index.html

  tutorials/index.html: examples/examples/tutorials.html
  tutorials/test-a-react-todo-app/introduction/: examples/examples/tutorials.html
  tutorials/test-a-react-todo-app/introduction.html: examples/examples/tutorials.html
  tutorials/test-a-react-todo-app/introduction-to-tutorials.html: examples/examples/tutorials.html
  tutorials/test-a-react-todo-app/: examples/examples/tutorials.html
  tutorials/: examples/examples/tutorials.html
  tutorials/test-a-react-todo-app/testing-inputs.html: examples/examples/tutorials.html
  tutorials/test-a-react-todo-app/react-todo-form-submission.html: examples/examples/tutorials.html
  tutorials/test-a-react-todo-app/react-todo-app-init.html: examples/examples/tutorials.html
  tutorials/test-a-react-todo-app/react-todo-item-testing.html: examples/examples/tutorials.html
  tutorials/test-a-react-todo-app/react-todo-toggle-debug.html: examples/examples/tutorials.html

  plugins/: plugins/index.html

  dashboard/index.html: guides/dashboard/dashboard-introduction.html
  dashboard/: guides/dashboard/dashboard-introduction.html
  dashboard/overview/: guides/dashboard/dashboard-introduction.html
  dashboard/overview/features-dashboard/: guides/dashboard/dashboard-introduction.html
  dashboard/overview/features-dashboard.html: guides/dashboard/dashboard-introduction.html
  dashboard/overview/projects-dashboard.html: guides/dashboard/dashboard-introduction.html
  dashboard/overview/organizations-dashboard.html: guides/dashboard/dashboard-introduction.html

  faq/index.html: faq/questions/using-cypress-faq.html

  #from Google Search Console/Webmaster Tools since 7/3/2017
  # https://docs.google.com/spreadsheets/d/1SHhjytMEzIxtdzFNXJHn_Q6p3xFFv_lFw0x_JtNtxt0/edit#gid=1581503717
  v1.0/docs/promise/: api/utilities/promise.html
  v1.0/docs/getcookie/: api/commands/getcookie.html
  v1.0/docs/getcookies/: api/commands/getcookies.html
  v1.0/docs/nextall/: api/commands/nextall.html
  v1.0/docs/prevuntil/: api/commands/prevuntil.html
  v1.0/docs/siblings/: api/commands/siblings.html
  v1.0/docs/clearcookie/: api/commands/clearcookie.html
  v1.0/docs/exec/: api/commands/exec.html
  v1.0/docs/setcookie/: api/commands/setcookie.html
  v1.0/docs/clear/: api/commands/clear.html
  v1.0/docs/cypress-minimatch/: api/utilities/minimatch.html
  v1.0/docs/first/: /api/commands/first.html

  docs/screenshots-and-videos/: guides/core-concepts/screenshots-and-videos.html
  docs/projects/: dashboard/overview/projects-dashboard.html
  docs/network-requests-xhr/: guides/guides/network-requests.html
  docs/environment-variables/: guides/guides/environment-variables.html
  docs/installing-and-running/: guides/getting-started/installing-cypress.html
  docs/configuration/: guides/references/configuration.html
  docs/cli/: guides/guides/command-line.html
  docs/wait/: api/commands/wait.html
  docs/launching-browsers/: guides/core-concepts/launching-browsers.html
  docs/known-issues/: guides/references/trade-offs.html
  guides/references/known-issues/: guides/references/trade-offs.html
  docs/finding-elements/: guides/core-concepts/introduction-to-cypress.html#Querying-Elements

  continuous-integration.html: guides/guides/continuous-integration.html

  # for chinese translation
  zh-cn/: zh-cn/guides/overview/why-cypress.html

  # obsolete content
  dashboard/overview/runs-dashboard.html: guides/dashboard/runs.html
  guides/core-concepts/launching-browsers.html: guides/guides/launching-browsers.html


# Include/Exclude Files/Folders
include:
  - api/utilities/** ## This ensures that our '_.md' file is included

# Writing
new_post_name: :title.md # File name of new posts
default_layout: post
titlecase: false # Transform title into titlecase
external_link: true # Open external links in new tab
filename_case: 0
render_drafts: false
post_asset_folder: false
relative_link: false
future: true
highlight:
  enable: false

# https://github.com/ele828/hexo-prism-plugin
prism_plugin:
  mode: 'preprocess'    # realtime/preprocess
  theme: 'coy'
  line_number: false    # default false

# Category & Tag
default_category: uncategorized
category_map:
tag_map:

# Date / Time format
## Hexo uses Moment.js to parse and display date
## You can customize the date format as defined in
## http://momentjs.com/docs/#/displaying/format/
date_format: MM-DD-YYYY
time_format: HH:mm:ss

twitter_username: Cypress_io
facebook_username: cypressio
github_username: cypress-io
github_main_repo: cypress-io/cypress
email: support@cypress.io
gitter: cypress-io/cypress
facebook_admin_id: 22600147
facebook_app_id: 446223215719535

# Google Plugins
google:
  tag_manager_id: GTM-KNKBWLD

# Crash reporting
sentry:
  dsn: https://b3169c504f3840d397b4987b3fd68697@sentry.io/1387466

## Algolia Search
## https://github.com/LouisBarranqueiro/hexo-algoliasearch
algolia:
  en:
    # Algolia application ID
    app_id: "R9KDA5FMJB"
    # Algolia SEARCH ID (not Write or Admin)
    api_key: "8e6c3119ee78db1ad10cd7bfb439d726"
    index_name: "cypress"

# Extensions
## Plugins: https://hexo.io/plugins/
## Themes: https://hexo.io/themes/
theme: cypress

## https://github.com/mamboer/hexo-renderer-scss
node_sass:
  outputStyle: nested
  precision: 5
  sourceComments: false

## https://github.com/ludoviclefevre/hexo-generator-seo-friendly-sitemap
sitemap:
  path: sitemap.xml

# configuration for Hexo Markdown rendering module

## https://github.com/hexojs/hexo-renderer-marked
marked:
  autolink: false
## https://github.com/hexojs/hexo-renderer-markdown-it
# markdown: 'default'