browser-sync README

The project's README from github.com/BrowserSync/browser-sync. As one markdown file: README.md.

Keep multiple browsers & devices in sync when building websites.

Follow @Browsersync on twitter for news & updates.

Ask questions on Discord

Features

Please visit browsersync.io for a full run-down of features

Requirements

Browsersync works by injecting an asynchronous script tag (<script async>...</script>) right after the <body> tag during initial request. In order for this to work properly the <body> tag must be present. Alternatively you can provide a custom rule for the snippet using snippetOptions

Upgrading from 1.x to 2.x ?

Providing you haven't accessed any internal properties, everything will just work as there are no breaking changes to the public API. Internally however, we now use an immutable data structure for storing/retrieving options. So whereas before you could access urls like this...

browserSync({server: true}, function(err, bs) {
  console.log(bs.options.urls.local);
});

... you now access them in the following way:

browserSync({server: true}, function(err, bs) {
  console.log(bs.options.getIn(["urls", "local"]));
});

Install and trouble shooting

browsersync.io docs

Integrations / recipes

Browsersync recipes

Support

If you've found Browser-sync useful and would like to contribute to its continued development & support, please feel free to send a donation of any size - it would be greatly appreciated!

Support via PayPal

Supported by

Originally supported by JH - they provided financial support as well as access to a professional designer to help with Branding.

Apache 2 Copyright (c) 2021 Shane Osbourne

browser-sync (BrowserSync/browser-sync)

Searching Database…

Что это такое?BrowserSync — инструмент для разработчиков, который синхронизирует несколько браузеров и устройств, пока вы делаете сайты: действие в одном браузере сразу повторяется в остальных прямо во время работы.
Это утилита, которую я запускаю во время разработки, или библиотека, которую я подключаю в коде?И то и другое: он поставляется как npm-пакет с интерфейсом командной строки, а также предоставляет публичный API, на основе которого можно строить другой код и интеграции.
Как запустить его у себя на компьютере?Установите npm-пакет (npm install -g browser-sync), затем следуйте руководству по установке и решению проблем на browsersync.io, чтобы начать работу.
Нужно ли сначала установить Node.js или что-то ещё?Да — он распространяется через npm как JavaScript-пакет, поэтому на компьютере должны быть Node.js и npm; при установке также подтянутся его зависимости для работы, например rxjs.
У меня версия 1.x — что-то сломается при обновлении до 2.x?Нет, если вы не обращались к внутренним свойствам: в публичном API нет критических изменений. Изменилось только внутреннее хранение опций, поэтому urls теперь читаются иначе.
Как BrowserSync попадает на мои страницы?Он работает через тег-сниппет на вашей странице — этот тег должен присутствовать, чтобы синхронизация работала; при необходимости можно задать своё правило для сниппета через snippetOptions.
Есть ли готовые примеры интеграции со средствами сборки?Да — в README есть ссылка на «Browsersync recipes», подборку готовых примеров интеграции для типовых сценариев.
Это бесплатно, и как поддерживается разработка?Это бесплатно, проект выпущен под лицензией Apache 2.0. Автор принимает пожертвования любого размера через PayPal, чтобы поддерживать дальнейшую разработку.
Size
14.5 MB
Stars
12.3K
Age
13y
Commits · 90 Days