0.0.1 • Published 1 year ago

posthtml-typograf v0.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

posthtml-typograf npm version

PostHTML-плагин для typograf.

Установка

npm i -E posthtml-typograf

Использование в произвольном коде

const { typografy } = require("posthtml-typograf");

// Где-то внутри middleware, получившей HTML-код:
const newHTML = typografy(oldHTML, ["ru/other/phone-number"]);

typografy принимает три аргумента (обязателен только первый из них):

  1. Обрабатываемый HTML-код.

  2. Отключаемые правила - массив (по умолчанию пустой).

  3. Опции типографа - объект (по умолчанию пустой), свойствами которого можно переопределить следующие предустановки плагиина:

    {
      "locale": ["ru", "en-US"],
      "htmlEntity": { "type": "name" }
    }

Использование в posthtml.config.js

const { getPosthtmlTypograf } = require("posthtml-typograf");

module.exports = () => ({
  plugins: [
    // other PostHTML plugins
    getPosthtmlTypograf(["ru/other/phone-number"]),
  ],
});

getPosthtmlTypograf принимает два аргумента:

  1. Отключаемые правила - массив (по умолчанию пустой).

  2. Опции типографа - объект (по умолчанию пустой), свойствами которого можно переопределить предустановки плагиина.