Documentation Guidelines

Resources

• Markdown Table Generator - https://www.tablesgenerator.com/markdown_tables#
• Markdown Extension for VSCode - https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
  • Preview: Ctrl+Shift+K+V
  • TOC: Ctrl+Shift+P type 'Markdown' > Update Table of Contents
• Github Markdown Guide - https://guides.github.com/features/mastering-markdown/
• git CMD/BASH: git pull, git add ., git commit -m 'Update-Git', git push

Policies, Principles and Syntax

• Denote ELEMENTS with all uppercase and wrap with the ` code tag
• Denote attributes with all lowercase and wrap with the ` code tag
• If mentioning a widget inner link to the corresponding wiki page ex:
  [`Documentation`](./Documentation-Guidelines) displays: Documentation
• add a fig. __ reference for each code block and image for referencing purposes.

Template

## Overview  <!-- omit in toc -->
A rough template for documentation to follow.

#### Table of Contents <!-- omit in toc -->
- [Overview](#overview)
    - [Table of Contents](#table-of-contents)
- [Usage](#usage)
    - [Ideals:](#ideals)
    - [Restrictions](#restrictions)
        - [Children:](#children)
- [Attributes](#attributes)
- [Examples](#examples)
    - [fig. a](#figa)
    - [img. a](#imga)

    

## Usage

#### Ideals:
<!--
- Short and concise covering basics
- Recommendations considering real use-cases
- Consistent layout applicable to all widgets
-->

#### Restrictions: 
##### Children:
Input `Code` Widget
> Only Code type inputs allowed

## Widget Parameters

| Name    | Type    | Default | Description | Req |
|---------|---------|---------|-------------|:---:|
|var name |var type | The default value of the variable | A brief description of the variables function |✔|
| visible | boolean |   true  |             |     |

## Examples

![Image Example of code output below](https://fml.dev/images/docs/example.png)
###### (*img. a*)
```xml
<CODE>
</CODE>

(fig. a)

Other Widgets You May Find Useful:

• A Link To Associated WIDGET
• A Link To Associated Documentation

## Images
You can upload images to the https://github.com/AppDaddy-Software-Solutions-Inc/Flutter-Markup-Language/tree/master/doc/img directory 

Embedding: `![Image Embed Example](https://fml.dev/images/docs/example.png)`