--- schema_version: "1" id: 3ef3599ad47ed768aff713efa244320549c25c97c87aa4c70121fcc039607d6e title: Creating Documentation Content collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/platform/aura-platform/guides/aura/docs/docs-auradoc.md canonical_url: https://developer.salesforce.com/docs/platform/aura-platform/guide/docs-auradoc.html source_site: developer.salesforce.com content_type: documentation content_hash: 784adac2bc5e3e976a08ddffac3484538bb9415a2ece027acb7379c44854bc00 products: - Lightning Aura Components Developer Guide - Platform Developer Content --- # Creating Documentation Content Documentation provides usage guidelines and code samples about a component, event, or interface. In the Component Library, the **Documentation** tab renders content from your .auradoc file. For an example, see the `lightning:avatar` Documentation tab at [https://developer.salesforce.com/docs/component-library/bundle/lightning:avatar/documentation](https://developer.salesforce.com/docs/component-library/bundle/lightning:avatar/documentation). Each component, event, or interface element can have one .auradoc file. ## Writing the Documentation Provide your content in HTML markup. Add usage guidelines and code samples to help developers use your component, event, or interface easily. To provide documentation, click **DOCUMENTATION** in the component sidebar of the Developer Console, which creates a `.auradoc` file for your component. A `.auradoc` file contains these tags. | Tag | Description | | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `` | Required. Creates documentation for a component, event, or interface. | | `` | Required. Describes the component using HTML markup. | | `` | References an example that demonstrates how the component is used. Supports HTML markup, which displays as text preceding the visual output and example component source. Use the example to create an interactive experience that demonstrates features of your component. Attributes are `name` (the API name of the example), `ref` (the reference to the example component in the format ``), and `label` (the title that describes the example). Each `.auradoc` file can contain multiple `` tags. | ## Basic Formatting We recommend that you use only the tags listed here and in the following sections. The Component Library strips out or escapes unexpected tags and attributes for security reasons. Make sure to include closing tags. **Heading** Only \

headings are supported for headings. ```html

Usage Considerations

``` **Paragraph** ```html

Some cool paragraph about a component

``` **Code Formatting** ```html

Here’s a paragraph on the c:myComponentName component.

``` ## Code Blocks Create a code block using the `
` tag and an embedded `` tag for code highlighting. Code markup must be escaped. For example, replace `<` characters with `<`.

```html

<aura:component>
   <lightning:accordion activeSectionName="B">
     <lightning:accordionSection name="A" label="Accordion Title A">This is the content area for section A</lightning:accordionSection>
     <lightning:accordionSection name="B" label="Accordion Title B">This is the content area for section B</lightning:accordionSection>
   </lightning:accordion>
</aura:component>

```

To enable code highlighting in the Component Library, add the `class` attribute to the `` tag. Code samples with Aura markup use the class `language-markup`. JavaScript controllers use `language-js`, and CSS use `language-css`.

## Links

The Component Library supports links to other component reference pages, external links, and cross-tab linking from the component reference to the Lightning Web Components Developer Guide.

Anchor links are currently not supported.

**Create a link to another component reference page**

```html
 lightning:input
```

**Create an external link**

```html


    For more information, see the
    Console Developer Guide.


```

**Create a link to a topic in the Lightning Web Components Developer Guide**

```html

  Navigate to Pages

```

## Lists

Lists present related items and can be bulleted or numbered.

**Create a bulleted list**

```html

lightning:listView supports the following features.


    
  
  • Inline editing
    • 
  
  • Mass inline editing for single record types
    • 
  
  • Resizing and sorting of columns
    • 
  
  • Search
    • 
  
  • Text wrapping
    • 
  
  • Loading of additional rows
    • 


```

**Create a numbered list**

```html

The toolbar provides menus and buttons that are ordered within the following categories.


    
  
  1. 
    FORMAT_FONT: Font family and size menus. The font menu provides the following font
    selection: Arial, Courier, Garamond, Salesforce Sans, Tahoma, Times New Roman, and Verdana. The
    font selection defaults to Salesforce Sans with a size of 12px. Supported font sizes are: 8, 9,
    10, 11, 12, 14, 16, 18, 20, 22, 24, 26, 28, 36, 48, and 72. When you copy and paste text in the
    editor, the font is preserved only if the font is available in the font menu.
  
    2. 
  
  2. FORMAT_TEXT: Bold, Italic, Underline, and Strikethrough buttons.
    3. 
  
  3. FORMAT_BODY: Bulleted List, Numbered List, Indent, and Outdent buttons.
    4. 
  
  4. 
    ALIGN_TEXT: Left Align Text, Center Align Text, and Right Align Text buttons.
  
    5. 
  
  5. 
    INSERT_CONTENT: Image button. The Image button displays if you include the
    lighting:insertImageButton component in lightning:inputRichText.
  
    6. 
  
  6. 
    REMOVE_FORMATTING: Remove formatting button, which stands alone at the end of the
    toolbar.
  
    7. 


```

## Tables

Tables are useful for presenting a list of items with several accompanying descriptions. Nesting a bulleted list in a table is currently not supported.

```html


  

    Property
    Type
    Description
  

  

    label
    string
    The text that displays next to a radio button.
  

  

    value
    string
    The string that's used to identify which radio button is selected.
  



```