SassDoc був натхненний і подобою JSDoc .
Так само, як будь-який інший генератор документації, SassDoc працює, захоплюючи коментарі SASS / СКС файлів і створення красивих, добре організована сторінку HTML документації із них.
Весь зміст добре структурований на розділи для роботи з функціями, змінних і Mixins. Посилання на оригінальні фрагменти коду і вихідного коду підсвічуванням також підтримується.
Крім того, стандартна тема SassDoc інші шаблони також доступні.
Щоб використовувати SassDoc ласка, перевірте документацію спочатку для відповідної інформації про те, як відформатувати SASS / СКС вихідного коду коментарі, так що вони можуть бути виявлені і використані двигуна SassDoc-х років.
Що нового У цьому випуску:
- Оновлення до Вавилонської 5,0
- Переконайтеся замовчуванням Назва теми правильно увійшли
- кілька залежностей
- Перейшли на ESLint
Оновлення
Що нового у версії 2.1.1:
- Оновлення зухвалість-перетворення версія для запобігання 6to5- Питання виконання описані в.
Що нового у версії 2.0.0:
- Вся API був повністю перероблений в ES6
- Знак $ тепер необов'язково при визначенні імені вparameter анотації
- Тепер можна використовувати шаблони файлів / папок винятку
- Це стало можливим труби SassDoc на стандартне введення
- - параметр налагодження був доданий висновок інформації про поточну налаштуванні
- Тема за замовчуванням тепер має конфігурацію googleAnalytics, що приймають Google Analytics ключ відстеження
- Тема за замовчуванням тепер має конфігурацію TrackingCode Ухвалення довільний HTML врізку для включення до & # x3c; / тіло і # x3e;
- content анотації тепер коректно виводиться в темі за замовчуванням
- Тема за замовчуванням тепер відображається тип, а також ім'я, коли зшивання пунктів (вимог, і так далі ...)
- Повідомлення про помилки повинні бути більш чітко, забезпечуючи ім'я файлу і рядок
- - розбір варіант був доданий у вихідних даних сировину розбору, як JSON з командного рядка
Тепер
Що нового у версії 1.10.6 :.
- Забезпечити належне перевірку типу дляsee анотації
Що нового у версії 1.10.3 :.
- Предотвращенниеrequires для автозаповнення залежність в два рази
Що нового у версії 1.8.0:
- Додана можливість додавати свої власні анотації до вашої теми
- Виправлена проблема з пункти будуть у випадковому порядку
Що нового у версії 1.6.0:
- Додана YEOMAN генератор, щоб зробити його легше побудувати Теми.
- Додана підтримка YAML файли конфігурації; Файл конфігурації за замовчуванням досі вважають, як і .json, .yaml або .yml.
- Додана повідомлення, щоб попередити проти покладаючись на ім'я файлу конфігурації за замовчуванням (вид. {JSON, YAML, ут}), так як він зламається у версії 2.0.0 на користь .sassdocrc (яка буде підтримувати як формат відразу в той час як будучи більш складна, більш зрозумілим і менш імовірно, до конфлікту з іншими проектами).
- Виправлена проблема, коли значення змінної "містить крапку з комою.
- Покращена світло тема (більше бічний перемикач з державами, що зберігаються в localStorage, краще код перемикання, поліпшення структури JavaScript, і краще продуктивність).
Що нового у версії 1.5.2:
- Додана неявного типу необхідних заповнювачів
Що нового у версії 1.4.1 :.
- Виправлена порушується тест
Що нового у версії 1.3.2 :.
- Виправлена порушується тест
Що нового у версії 1.1.6:
- Backport, фіксована знайшли, по крайней з абсолютною шляху.
Вимоги
- Node.js
Коментар не знайдено