Documentation Template

Welcome to the docs template!

This template is intended for documenting a feature within a plugin or theme, but it's a great start for any other type of documentation where you're focusing on a single topic. Feel free to use this as a starting point, and modify it as you see fit. This will give you a good starting point using the conventions we've set up in the Responsive Framework documentation.

Some tips:

• You can link to specific line numbers (or chunks of code) by clicking or shift-clicking on the line numbers in your repo. Your URL will automatically update. See this Stack Overflow post for details.
• When creating code examples, try to think of some common scenarios your users might run into. If your plugin is already out there, take a few minutes and see how people used it.
• If something requires knowledge that isn't in the scope of the document, but is required to use your feature, provide a code example to help people get going or link to a resource where people can learn more.

A brief description of your feature's intended use should go here.

Requirements:

• Document and link to any requirements here.

---

Contents:

Use the doctoc /path/to/file command to easily generate this from your final file. Don't have doctoc? Install it here.

• Shortcode
  • Attributes
  • Examples
    • Option 1
    • Option 2
    • Option 3
• Overriding styles
• Code Reference
  • Templates
  • Classes
    • your_function_here()
    • your_function_that_accepts_stuff( $yourStuff, $yourFancyStuff )

---

Shortcode

Attributes

Please fill in basic descriptions of attributes.

• yourAttr - Basic description.
• yourAttrWithOptions - List the default. List options below.
  • option1 - Link to the example.
  • option2 - Link to the example.
  • option3 - Link to the example.
• yourAttrWithDefaultParam - Basic description. List the default.

Simple Example:

Provide a basic code example.

Side note or extra information: You can put any notes in blockquotes like this.

Examples

Option 1

Your example here.

Provide a code example if applicable.

Screenshot if applicable

Option 2

Your example here.

Provide a code example if applicable.

Screenshot if applicable

Option 3

Your example here.

Provide a code example if applicable.

Screenshot if applicable

Overriding styles

If your plugin includes a custom stylesheet, document that here.

Document any additional breakpoints that do not follow Responsive default. Additionally, if the styles are not mobile-first (for example - if you used max-width for any reason), document that here as well.

Side note about IE: Make a note of lt-ie9 classes if necessary, or whatever you choose to do to deal with IE.

Code Reference

Templates

Document templates or includes in this section.

Classes

Document any classes that are meant to be accessible to developers for theme development. Include examples and a brief explanation of the classes intended use.

If no classes are meant to be used by devs, make a note of it here so it's clear and provide your preferred alternative.

your_function_here()

Brief description of intended use.

Provide a simple code example of that use.

your_function_that_accepts_stuff( $yourStuff, $yourFancyStuff )

Brief description of intended use.

Accepts:

• $yourStuff: Provide a description of what this accepts.
• $yourFancyStuff: Provide a description of what this accepts. If it's complicated, provide an example.

Example 1: Do something basic

Provide a simple code example of that use.

Example 2: Do something more complicated

Provide a more complicated code example.