https://github.com/erikmd/gitpod-tp-env

Template repository for Emacs-in-Browser-Terminal using Dotfiles from https://github.com/erikmd/gitpod-workspace-emacs-nw
https://github.com/erikmd/gitpod-tp-env

Last synced: 27 days ago
JSON representation

Template repository for Emacs-in-Browser-Terminal using Dotfiles from https://github.com/erikmd/gitpod-workspace-emacs-nw

• Host: GitHub
• URL: https://github.com/erikmd/gitpod-tp-env
• Owner: erikmd
• Created: 2023-09-27T07:41:27.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-21T18:12:18.000Z (3 months ago)
• Last Synced: 2024-10-22T08:42:58.073Z (3 months ago)
• Homepage:
• Size: 93.8 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gitpod-tp-env

## Using Emacs in Gitpod (Cloud dev. env.) for OCaml/Coq

1. Fork this repository (or use GitHub's template feature) so that it includes this [.gitpod.yml](./.gitpod.yml) file.

2. Log in [Gitpod Classic](https://gitpod.io/login/) using your **GitHub** account.

3. Open your [Gitpod **Preferences**](https://gitpod.io/user/preferences)

   * Set your **Dotfiles Repository URL**: `https://github.com/erikmd/gitpod-workspace-emacs-nw`

4. Open [the **Gitpod URL** `https://gitpod.io/new/?autostart=false&editor=xterm`](https://gitpod.io/new/?autostart=false&editor=xterm)

   * Fill the form with **the URL of your own GitHub repository**

   * Select the **`Terminal` editor** and click on `Continue`

   * If ever the loading takes too much time, try to reload the tab once (Ctrl+R)

5. Run `emacs` in the workspace shell (based on [`tmux`](https://github.com/tmux/tmux/wiki))

6. Note the existence of the `(?)` special menu in Emacs, also:

   * type Alt+F1 or Ctrl+F1 to get some help on the main key bindings;

   * type F7 to disable xterm-mouse-mode and thus allow copy-and-paste with the mouse.

7. Open an OCaml (C-x C-f code.ml RET) or Coq (C-x C-f code.v RET) file.

> [!TIP]

> You may also be interested in the [Gitpod **Browser Extension**](https://www.gitpod.io/docs/configure/user-settings/browser-extension) to create workspaces more easily from other repositories/PRs.

## At the end of the session

* You can save your work by using Git commands, for example:  

  `git commit -a -m "WIP" && git push`

* Otherwise, you might want to `Pin` the workspace in .

## Screenshots

### `tmux` session at startup



### `emacs` in tty mode with mouse enabled



## Limitation

This approach relies on the Gitpod Classic plans which are intended to

be replaced with [Gitpod Flex](https://www.gitpod.io/pricing) after

April 2025.