Giter VIP home page Giter VIP logo

zero-to-emacs-and-org-roam's Introduction

Creative Commons License

Notes on Org-roam V2

As of 17 Jul 2021, V2 has been released. Both MELPA and MELPA-Stable have this version of Org-roam. It will be markedly different from v1 for both its initial setup and daily usage. At the moment, most of the content of guide will only be applicable to v1 for Org-roam and its related packages such as Org-roam-bibtex.

I am gradually revising this guide in its entirety for v2.

So far the following chapters have been updated:

  1. Get Emacs for Windows
  2. Use Emacs to write some text (including copy & paste)
  3. Improve quality-of-life with your font, theme, and minimal select packages
  4. Set up Org-roam (including MSYS2 and emacsql-sqlite.exe) [WIP but main parts are illustrated with a series of screen shots, so you should be able to install Org-roam V2]

The the latest version of this guide compatible for v1 is available in the v1 branch of this repositry.

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).

I won't repeat why you might like to use Emacs or plain text to write. Here is what I think is the best response to the question: "The Plain Person’s Guide to Plain Text Social Science" by Kieran Healy of Duke University.

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

[ Image to be inserted after writing up Part 1]

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. Improve quality-of-life with your font, theme, and minimal select packages
  4. Set up Org-roam (including MSYS2 and emacsql-sqlite.exe) [WIP but main parts are illustrated with a series of screen shots]

Part 2

  1. (maybe) How to swap CapsLock with Ctrl
  2. Set up Org-roam-ui for a graph visualization of your notes
  3. Set up Org-ref and Org-roam-bibtex (ORB)
  4. Export to MS Word
  5. Set up a spell checker (Hunspell, including how to get it)

Part 3

  1. Work with PDF files in Emacs with PDF-Tools, Org-noter, and ORB
  2. Insert an image from the clipboard, or the Snipping Tool on Windows (incl. in-line display resizing without Imagemagick, or external programs)

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.

zero-to-emacs-and-org-roam's People

Contributors

flakyhermit avatar joshuaadrianjones avatar justinabrahms avatar nobiot avatar pajot avatar

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.