Giter Club home page Giter Club logo

xrefresh-emacs's Introduction

xrefresh.el

You're looking at an Emacs-based server for xrefresh. Use it to automatically refresh your browser as you're developing in Emacs.

This obviously goes very well with Emacs' "never leave the home row" philosophy. Just hit C-f C-s and watch your browser window update.

Feedback

Please send any questions, suggestions and other feedback to [email protected].

Usage

  1. Download xrefresh.el

  2. Add the following to your dot-emacs:

    (require 'xrefresh)
(xrefresh-start)

    For customizing your configuration, please see below.

  3. Use the XRefresh browser plugin of your choice.

Configuration

How can I change the server port?

Simply pass the port as a parameter like so:

   (xrefresh-start 1337)

You can even start multiple servers on different ports if you so desire. Not really sure what the point would be, but eh, you only live once.

What if my Emacs is running on a different machine than my browser?

From XRefresh FAQ

XRefresh monitor communicates with browser extension using TCP/IP. So, it is possible, but it may be tricky because you need to disable firewall and make sure they see each other. By default browser extension tries to connect to 127.0.0.1 on port 41258. In Firefox type about:config into the URL bar and filter keys by "xrefresh". Keys extensions.xrefresh.host and extensions.xrefresh.localConnectionsOnly are what you are looking for.

[TODO: Explain more configuration options.]

Outstanding issues

  • Plugin doesn't transmit CSS file contents - so CSS live reload does not work. Works now

Please report any issues to [email protected]

Thanks to

Dhruva Krishnamurthy - emacsserver.el

Binaryage - Makers of XRefresh

xrefresh-emacs's People

Contributors

justmoon avatar tarsius avatar

Stargazers

Kent Li avatar avatar Antonin Hildebrand avatar

Watchers

avatar James Cloos avatar avatar

xrefresh-emacs's Issues

Please specify the license for this package

Could you please specify the license used for this package?

Assuming that you want to release under "the GPL v3 or any later version", the best way to do that would be to add this permission statement to the library header:

;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.

;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

Also consider adding a LICENSE file containing the text of the GPL-3. You could add just that file without also adding the above persmission statement, but if you do that, then the "or (at your option) any later version" bit won't be known. So I recommend that you add both the actual license and the permission statement.

If you find the permission statement to be too noisy, then you could instead add one of these following lines to the header. If you do that, then it becomes more important to also add the LICENSE file - a judge might decide that such a line by itself is not sufficient. Still, adding just such a line is better than not specifing the license at all.

;; License: GNU General Public License version 3, or (at your option) any later version
;; License: GNU General Public License version 3, or any later version
;; License: GNU GPL version 3, or (at your option) any later version
;; License: GPL version 3, or (at your option) any later version
;; License: GPL version 3, or any later version
;; License: GPL v3, or (at your option) any later version
;; License: GPL v3, or any later version
;; License: GPL-3+

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.