stylelint-sassdoc/src/rules/poster-comment/README.md

stylelint plugin to check scss files for a valid sassdoc documentation Credits to https://github.com/anneangersbach

# poster-comment
Checks the beginning of the file for a valid poster comment beginning and ending with ////.
It also checks for exactly one @group occurence
and 0 - 1 @group-name occurences. This is a custom property we use for our project.
If you do not need it, don't worry about it.

> ** Ignores poster comments further down in the file. **

## Information about @example
http://sassdoc.com/file-level-annotations/

### Description:
Usually, the poster comment goes on top of the file.
In order to be parsed as a poster, it has to be prefixed by ////.
You should have 4 slashes on the first and last lines (which are usually empty lines), and any number of slashes in between (3, 4, 5…).

### Example of usage
```scss
////
/// This is a poster comment.
/// It will apply annotations to all items from file.
/// @group typography
/// @group-name Typography
////
```