This repo contains the markdown documentation for Sauce Labs.
Every markdown document in the markdown folder of this repo has a required metadata section which should be valid a JavaScript object containing the title(used in the nav, title section, URL, search results, and as part of the naming conventions below), description(used in the meta description), category(used in the nav, URL and as part of the naming conventions), 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.
All markdown file names should be lowercase, dasherized, and be placed inside the corresponding category folder. For example a doc with the category Tutorials entitled Sample Tutorial would be located at markdown/tutorials/sample-tutorial.md. Images relating to docs are found in the same relative location as markdown files. A main doc image for Sample Tutorial would be located at markdown/tutorials/sample-tutorial.png while an image in the content of the doc would be located at markdown/tutorials/sample-tutorial/content-image.png.
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 when hovering over code blocks 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.