h1 per page/document?There are no implementations of the proposed outline algorithm in web browsers nor assistive technology; it was never part of a final W3C specification. Therefore the outline algorithm should not be used to convey document structure to users. Authors are advised to use heading rank (h1-h6) to convey document structure.
| 'use strict'; | |
| var gulp = require('gulp'); | |
| var postcss = require('gulp-postcss'); | |
| gulp.task('styles', function () { | |
| var opts = { | |
| basePath: 'input/', | |
| maps: [ 'whatever.yml' ], | |
| }; |
SassDoc allows to document Sass items: functions, mixins, variables, placeholders.
No CSS selectors.
It uses a similar system as JSDoc, based on comments and annotations.
You can choose between two types of comments.
Inline comments (3 slashes):
///
///
| // Programmatically install npm packages. | |
| function npmInstall(pkgs, cb) { | |
| var npm = require('npm'); | |
| npm.load({}, function (err) { | |
| if (err) { | |
| throw err; | |
| } | |
| console.log(chalk.red( |
| // ---- | |
| // Sass (v3.3.9) | |
| // Compass (v1.0.0.alpha.20) | |
| // ---- | |
| // Prime number | |
| // https://en.wikipedia.org/wiki/Prime_number | |
| // Returns whether `$n` is a prime number. |