/Zero-to-Emacs-and-Org-roam

Step by step guide from zero to installing and setting up Emacs and Org-roam on Windows 10

Primary LanguageEmacs LispOtherNOASSERTION

Creative Commons License

Zero to Emacs and Org-roam: a step-by-step guide on Windows 10

I took the liberty of creating a step-by-step guide for people new to Emacs. I have written this with Windows users with no Linux or programming background in mind, zero about Emacs.

The guide aims to get you going real quick, starting with downloading Emacs with vanilla configuration (no Doom, no Spacemacs).

At the end of step-by-step guide of Part 1, your Emacs will look like this.

What your Emacs will look like at the end of Part 1

In addition, I have added an extra chapter to show you how you might personalize the look & feel of your Emacs, using Doom as a reference. I personally do not use this set up, preferring to be as minimal as I can be for my own purposes. I am aware my preference is perhas rather eccentric (who isn't?); this dark-mode-centric slick look might be something many others want to go for.

Extra 2. Make vanilla Emacs look like Doom

Outcome screen shot

Audience and purpose in mind

The audience I have had in mind are:

  • New to Emacs
  • Windows users (Emacs part should be useful for others, I hope)
  • No programming or Linux background
  • Looking to use Org-roam / Emacs to help write long-form material (essays / papers about life, humanities, or some qualitative social sciences, etc.) as opposed to math and programming

Even if you are already down the path of using a framework like Doom, I hope stepping back a little and actually finishing configuration from scratch will help you understand how things fit together – it’s a bit like DIY making stuff; completing one thing from start to finish seems to help you leap to the next level of understanding and confidence for some reason.

Part 1

  1. Get Emacs for Windows
  2. Use Emacs to write some text (including copy & paste)
  3. Set up Org-roam (including sqlite3)
  4. Improve quality-of-life with your font, theme, and minimal select packages
  5. Some more quality-of-life improvements for your typography -- font variations and line-spacing -- and other things

The config file at the end of Part 1 is located in this repo, too. Refer to its history if you wish to see the incremental changes as we move along advanced chapters.

Part 2

  1. Set up Org-ref and Org-roam-bibtex (ORB)
  2. Export to MS Word
  3. Set up a spell checker (Hunspell, including how to get it)

Part 3

I consider the following "extra" features because they require a certain level of "hacking the system". I suggest that you selectively decide whether or not you would like to take on the challenges, depending on your familiarity wth the technical stuff on Windows.

  1. Set up org-protocol, org-roam-graph, and org-roam-server (incl. Windows registry)
  2. Work with PDF files in Emacs with PDF-Tools, Org-noter, and ORB
  3. Insert an image from the clipboard, or the Snipping Tool on Windows (incl. in-line display resizing without Imagemagick, or external programs)
  4. (maybe) How to swap CapsLock with Ctrl
  5. (maybe) Export to PDF

Extra

Extra 1: I have added a script that automates installation of packages that I describe in this guide up to Chapter 6 on ORB. Let me know how you go.

Extra 2: Make vanilla Emacs look like Doom


At the end of chapter 6 on ORB, you will get to this point where you can use ORB. Add a bibliographic note

Chaper 7 is now published. It demonstrates a way to export your Org notes to MS Word. Resultant .docx files look like this: Export to MS Word docx document

Chapter 9 lets you play with interactive visualisation of your notes and their relationships via org-roam-server:

Animation showing org-roam-sever interacting with Emacs

Chapter 10 provides an easy step-by-step instruction on how to install PDF-Tools on Windows, and configure Org-noter to work with ORB.

Open a PDF docuement with PDF-Tools in Emacs; work with Org-noter to take notes

Extra 2 lets you make vanilla Emacs look like Doom.

Outcome screen shot

License

Creative Commons License
This work is licensed under a CC BY-SA 4.0 license, except for source code and documentation excerpts from Emacs and Org-roam project.