chriswren / docs

Sauce Labs markdown docs

Sauce Labs Docs

This repo contains the markdown documentation for Sauce Labs.

Editing Markdown

Every markdown document in the markdown folder of this repo has a required metadata section which should contain the title, description(used in the meta description), category(used in the nav and URL), and the index(used to determine the document's position in the navigation relative to other documents in the same category). You can also optionally include an image for a doc which will be used in the nav, search results, and title section on the doc's page. The supported version of markdown is GitHub flavored markdown as described here.

Custom Markdown processing

Any code block containing sauceUsername or sauceAccessKey will either get replaced by the logged-in user's credentials or be replaced by YOUR_USERNAME, and YOUR_ACCESS_KEY respectively. If the user is logged out, there will be a button present on hover prompting the user to login. Additionally, code blocks with a programming language defined will have a button present on hover to allow users to copy code to their clipboard.