https://github.com/wesnel/elsewhere

Open version-controlled code from Emacs in your web browser
https://github.com/wesnel/elsewhere

emacs emacs-lisp emacs-package emacs-packages git github gitlab lisp sourcehut

Last synced: about 2 months ago
JSON representation

Open version-controlled code from Emacs in your web browser

• Host: GitHub
• URL: https://github.com/wesnel/elsewhere
• Owner: wesnel
• License: gpl-3.0
• Created: 2023-07-24T02:51:16.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-07T03:58:25.000Z (over 1 year ago)
• Last Synced: 2025-04-28T13:08:44.477Z (about 2 months ago)
• Topics: emacs, emacs-lisp, emacs-package, emacs-packages, git, github, gitlab, lisp, sourcehut
• Language: Emacs Lisp
• Homepage:
• Size: 3.28 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
[![License: GPL 3](https://img.shields.io/badge/license-GPL_3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.txt)

[![CI](https://github.com/wesnel/elsewhere/workflows/CI/badge.svg)](https://github.com/wesnel/elsewhere/actions?query=workflow%3ACI)

[![Coverage Status](https://coveralls.io/repos/github/wesnel/elsewhere/badge.svg?branch=main)](https://coveralls.io/github/wesnel/elsewhere?branch=main)

# `elsewhere.el`

**Open version-controlled code from Emacs in your web browser.**

Use `elsewhere.el` to open a file (or a marked region of a file) as a permalinked webpage in your browser.

**Table of Contents**

- [`elsewhere.el`](#elsewhereel)

    - [Usage](#usage)

    - [Demo](#demo)

        - [`elsewhere-open`](#elsewhere-open)

        - [`elsewhere-build-url`](#elsewhere-build-url)

    - [Requirements](#requirements)

    - [Currently-Supported VC Back Ends](#currently-supported-vc-back-ends)

        - [Git](#git)

    - [How is `elsewhere.el` different from `git-link`?](#how-is-elsewhereel-different-from-git-link)

## Usage

Open a version-controlled file, (optionally) mark a region in the file, and execute `M-x elsewhere-open`. You should see a webpage open in your browser. If you want the URL but you don't want to automatically open it in your browser, then try `M-x elsewhere-build-url` instead. With that command, you should see the URL in your echo area.

## Demo

### `elsewhere-open`

![elsewhere-open](https://raw.githubusercontent.com/wesnel/elsewhere/demo/elsewhere-open.gif)

### `elsewhere-build-url`

![elsewhere-build-url](https://raw.githubusercontent.com/wesnel/elsewhere/demo/elsewhere-build-url.gif)

## Requirements

> [!IMPORTANT]

> Currently, `elsewhere.el` requires Emacs version `29.1` or newer. You can check your Emacs version by typing `M-x emacs-version`.

## Currently-Supported VC Back Ends

### Git

- [GitHub](https://github.com/)

- [GitLab](https://gitlab.com/)

- [Sourcehut](https://git.sr.ht/)

## How is `elsewhere.el` different from `git-link`?

The [`git-link`](https://github.com/sshaw/git-link) package is similar to `elsewhere.el`. There are several minor differences between that package and `elsewhere.el`, but the primary benefit of `elsewhere.el` is that it supports multiple version control back ends other than Git. In fact, since `elsewhere.el` is built on top of the built-in `vc` package, support could theoretically be added for any back end listed [here](https://www.gnu.org/software/emacs/manual/html_node/emacs/Version-Control-Systems.html).