Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/editor-bootstrap/emacs-bootstrap
Your on-the-fly Emacs development environment.
https://github.com/editor-bootstrap/emacs-bootstrap
bootstrap dotfiles editor-bootstrap emacs emacs-bootstrap emacs-configuration starter-template
Last synced: 3 days ago
JSON representation
Your on-the-fly Emacs development environment.
- Host: GitHub
- URL: https://github.com/editor-bootstrap/emacs-bootstrap
- Owner: editor-bootstrap
- License: mit
- Created: 2016-11-05T22:33:25.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-26T07:09:59.000Z (over 2 years ago)
- Last Synced: 2024-12-08T11:36:10.084Z (15 days ago)
- Topics: bootstrap, dotfiles, editor-bootstrap, emacs, emacs-bootstrap, emacs-configuration, starter-template
- Language: CSS
- Homepage: http://emacs-bootstrap.com
- Size: 1.7 MB
- Stars: 167
- Watchers: 14
- Forks: 23
- Open Issues: 17
-
Metadata Files:
- Readme: README.org
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# emacs-bootstrap
* Emacs Bootstrap
http://emacs-bootstrap.com
Your on-the-fly Emacs development environment.
Emacs-bootstrap uses opinionated code templates which will be used to generate your emacs configurations.
It enables you to select the programming languages you work with the most and will generate enough Emacs configs
to get you started crunching code.
* Features
1. Multiple programming languages available
2. Theme selection
3. Completion frontend installation
* Installation
Head over to [[http://emacs-bootstrap.com][Emacs-bootstrap]] and generate your configs.
Once you've download the configs, unzip the file and:
#+BEGIN_SRC shell
cp -R [CONFIG_DOWNLOAD_DIR] ~/.emacs.d
#+END_SRC
Then launch emacs and wait for a bit while Emacs packages are installed to prepare your environment.
* Shortcuts
Here are some basic shortcuts that Emacs provides along with configured shortcuts by Emacs-bootstrap:
Note that C- means pressing your Control key + some other key. For example, C-x means Control + X.
Same goes for M which is your Meta key. That can be the Escape key on your keyboard or the ALT key.
|----------+----------------------+----------|
| Shortcut | Function | Provider |
|----------+----------------------+----------|
| C-x C-f | Open file | Emacs |
| C-x C-s | Save file | Emacs |
| C-x C-b | Switch buffer | Emacs |
| C-x C-k | Kill buffer | Emacs |
| C-s | Search in file | Emacs |
| M-% | Find and Replace | Emacs |
| C-x 1 | Only show 1 buffer | Emacs |
| C-x 2 | Split horizontally | Emacs |
| C-x 3 | Split Vertically | Emacs |
| C-x 0 | Remove current split | Emacs |
|----------+----------------------+----------|
One of the packages installed is called 'which-key' which displays the list of available keys after a certain prefix.
Try it out, press C-x and which-key will display available shortcuts that you can use to invoke a certain functionality.
|------------------+------------------------------------------+-------------------------------------|
| Shortcut | Function | Provider / Package |
|------------------+------------------------------------------+-------------------------------------|
| C-C Space | Ace-jump-mode (Code navigation) | Bootstrap / Ace-Jump |
| C-= | Expand Region (Smart code selection) | Bootstrap / Expand-region |
| M-x or (C-x C-m) | Ivy-counsel / Helm (Completion frontend) | Bootstrap / Ivy / Helm |
| C-x c k | Emacs kill ring (Emacs clipboard) | Bootstrap / Ivy / Helm |
| C-x v | Open file in project | Bootstrap / Projectile |
| C-x c p | Search in project | Bootstrap / Projectile-ag |
| C-x s | Advanced search in file | Bootstrap / Ivy-swiper / Helm-swoop |
| C-x UP | Go to buffer above (In split) | Bootstrap / Windmove |
| C-x Down | Go to buffer below (In split) | Bootstrap / Windmove |
| C-x Left | Go to buffer on the left (In split) | Bootstrap / Windmove |
| C-x Right | Go to buffer on the right (In split) | Bootstrap / Windmove |
|------------------+------------------------------------------+-------------------------------------|
Programming language specific shortcuts:
|----------+----------------------------------------------------------+----------------------+--------------------------|
| Shortcut | Function | Programming Language | Provider / Package |
|----------+----------------------------------------------------------+----------------------+--------------------------|
| C-x p e | Pyenv activate in current project | Python | python-mode, elpy, pyenv |
| M-. | Go to definition | Python | python-mode, elpy, pyenv |
| M-, | Navigate back to previous position | Python | python-mode, elpy, pyenv |
| | | | |
| C-c C-r | Remove unused imports | Golang | go-mode |
| C-c C-g | Go to imports | Golang | go-mode |
| M-. | Go to defintion | Golang | go-mode |
| | | | |
| C-c j r | JavaScript refactor mode | JavaScript | js2-mode, js2-refactor |
| C-c C-b | Send the buffer to the inferior JavaScript process | JavaScript | js2-mode, js-comint |
| C-c C-l | Load a file in the javaScript interpreter | JavaScript | js2-mode, js-comint |
| C-x C-e | Send previous sexp to inferior JavaScript process | JavaScript | js2-mode, js-comint |
| C-M-x | Send previous sexp to inferior JavaScript process and go | JavaScript | js2-mode, js-comint |
| | | | |
| C-j | emmet-mode expand snippet | HTML | web-mode, emmet-mode |
| C-c [ | emmet-mode previous edit point | HTML | web-mode, emmet-mode |
| C-c ] | emmet-mode next edit point | HTML | web-mode, emmet-mode |
| C-c o b | Open the current file in the browser | HTML | web-mode |
|----------+----------------------------------------------------------+----------------------+--------------------------|
* Awesome Emacs Learning Resources
*** Reading content
- Emacs RTD (http://emacs.readthedocs.io/en/latest/)
- Endless Parenthesis (http://endlessparentheses.com/)
- What the emacs.d? (http://whattheemacsd.com/)
- Pragmatic emacs (http://pragmaticemacs.com)
- Planet emacsen (http://planet.emacsen.org/)
*** Video Content:
- Using Emacs (http://cestlaz.github.io/stories/emacs/)
- Emacs Rocks (http://emacsrocks.com/)
*** Other
- Awesome Emacs (https://github.com/emacs-tw/awesome-emacs)
* Contribution
I would love to extend Emacs-bootstrap to support other programming languages as well.
If you think you've got your configuration of your favorite programming language perfectly,
please don't hesitate to submit a PR.
Please check the list of issues as i have created am issue for the missing language support Emacs-Bootstrap lacks.
* Credit
Special thanks for [[https://github.com/avelino][Thiago Avelino]] for allowing the usage of Vim-Bootstrap's template. And [[http://faisal.me/][Faisal Al-Da'aja]] for customizing the look and feel.
* Dedication
This website is dedicated to my lovely Wife who became curious about Emacs after i bragged so much about it.
* License
MIT License