Git Product home page Git Product logo

browsersync's Introduction

browsersync

Build Status

This tool is a Golang version of a paired down browsersync, which features live-reloading of HTML (the only feature I need) in a simple single-binary executable. It works by prepending the </body> of HTML pages with some Javascript that caches the current scroll and also listens to a websockets for file changes to trigger a browser reload.

Install

go install -v github.com/schollz/browsersync@latest

Usage

Basic usage

You can just run browsersync in a directory:

$ browsersync

And then load your browser to localhost:8003 which will render index.html. Any other URL will load the respective file on the computer.

Rendering Markdown

You can also use this to render markdown. The simplest way is to use

$ browersync --index README.md

which will define the README.md to be the index page and automatically turn on Markdown rendering.

Alternatively, if you want to use your own styling, you simply make an HTML page, like index.html with the following:

<html>
    <body>
        {{ MarkdownToHTML "../README.md" }}
    </body>
</html>

When you go to that page, the browsersync will automatically convert the specified markdown file (e.g. README.md in that example) and any changes in the file will be shown in the browser. See example for more info.

Contributing

Pull requests are welcome. Feel free to...

  • Revise documentation
  • Add new features
  • Fix bugs
  • Suggest improvements

License

MIT

browsersync's People

Contributors

schollz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.