help-content.html 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. <div bs-panel="controls outline">
  2. <h1 bs-heading><svg bs-svg-icon><use xlink:href="#svg-"></use></svg> Help Content</h1>
  3. </div>
  4. <div bs-panel>
  5. <div bs-panel-content="basic">
  6. <p class="lede">
  7. Browsersync is an open-source project created and maintained by the front-end designers/developers at [JH](http://www.wearejh.com)
  8. . Together with contributors from all over the world, we aim to make modern, multi-device web development faster & easier.
  9. </p>
  10. </div>
  11. </div>
  12. <div bs-panel>
  13. <div bs-panel-content="basic">
  14. <h2>Help</h2>
  15. <dl>
  16. <dt>Why isn&rsquo;t Browsersync connecting with my project?</dt>
  17. <dd>99% of the time, it's because your web page doesn't have a `body` tag.
  18. In order for Browsersync to connect properly the `body` tag must be present in your website (we add a script tag just after it).
  19. Alternatively you can provide a custom rule for the snippet using [snippetOptions](http://www.browsersync.io/docs/options/#option-snippetOptions)
  20. </dd>
  21. <dt>Which mode should I be running in?</dt>
  22. <dd>
  23. <ul>
  24. <li>If you have simple HTML, CSS & JavaScript files, you need the [server option](http://www.browsersync.io/docs/options/#option-server).</li>
  25. <li>If you already have an existing server setup (such as an Express app, Mamp, Rails etc, then you need the [proxy option](http://www.browsersync.io/docs/options/#option-proxy).</li>
  26. <li>If you intend to copy/paste the snippet into your website manually, you use the `snippet` mode. This is the default mode and is
  27. achieved by omitting both the server & proxy options</li>
  28. </ul>
  29. </dd>
  30. <dt>Where can I report an issue?</dt>
  31. <dd>
  32. <p>If you have found an issue with the Browsersync UI, please use our [issue tracker](https://github.com/Browsersync/UI/issues) </p>
  33. </dd>
  34. </dl>
  35. <hr>
  36. <p>Need more assistance? Please try our [documentation](http://www.browsersync.io/docs/) for user guides or our [stackoverflow](http://stackoverflow.com/questions/tagged/browser-sync) tag for answers to common problems.</p>
  37. </div>
  38. </div>
  39. <div bs-panel>
  40. <div bs-panel-content="basic">
  41. <h2>Contribute</h2>
  42. <p>We'd love for you to contribute to Browsersync and help make it even better than it is today! Please read our [contributor guidelines](https://github.com/shakyShane/browser-sync/blob/master/CONTRIBUTING.md).</p>
  43. </div>
  44. </div>