README.md (2964B)
1 # poet [![MELPA](https://melpa.org/packages/poet-theme-badge.svg)](https://melpa.org/#/poet-theme) 2 A light emacs theme that's well suited for prose: particularly org-mode and markdown-mode; or any mode that works well with `variable-pitch` mode. 3 4 ## Motivation 5 The main idea behind this was to make Emacs more friendly for writing prose instead of code. Highlights include mixing monospace and variable pitch text in markdown and org-modes, making it convenient to write prose and code together. For example, 6 7 ![Screenshot](https://github.com/kunalb/poet/raw/master/screenshots.png) 8 9 ## Set up 10 - **Installation**: 11 - **Melpa**: Make sure [melpa is in your package archives list](https://melpa.org/#/getting-started), and <kbd>M-x</kbd> `package-install poet-theme` 12 - **Manual**: Download the theme to your `custom-theme-directory` which defaults to `~/emacs.d`. 13 - **Variable-pitch-mode**: Adding variable pitch mode to text modes will help in rendering mixed fonts every time you edit markdown, org-mode, etc. 14 ``` 15 (add-hook 'text-mode-hook 16 (lambda () 17 (variable-pitch-mode 1))) 18 ``` 19 - **Custom fonts**: Choose your fonts/font sizes before loading the theme with 20 ``` 21 (set-face-attribute 'default nil :family "Iosevka" :height 130) 22 (set-face-attribute 'fixed-pitch nil :family "Iosevka") 23 (set-face-attribute 'variable-pitch nil :family "Baskerville") 24 ``` 25 - **Mac OSX Title Bar**: Only for **Emacs 26.1** 26 ``` 27 (add-to-list 'default-frame-alist '(ns-transparent-titlebar . t)) 28 (add-to-list 'default-frame-alist '(ns-appearance . light)) 29 ``` 30 - **Additional useful modes**: Some modes I like to enable/disable 31 ``` 32 (olivetti-mode 1) ;; Centers text in the buffer 33 (flyspell-mode 1) ;; Catch Spelling mistakes 34 (typo-mode 1) ;; Good for symbols like em-dash 35 36 (blink-cursor-mode 0) ;; Reduce visual noise 37 (linum-mode 0) ;; No line numbers for prose 38 39 (setq org-bullets-bullet-list 40 '("◉" "○")) 41 (org-bullets 1) 42 ``` 43 44 ## [Reddit](https://www.reddit.com/r/emacs/comments/9e01wf/share_your_modern_emacs/e5lpfmy/) reviews poet 45 ![Reddit](https://github.com/kunalb/poet/raw/master/reddit.png) 46 47 ## Warning 48 - Exclusively aimed at graphical emacs 49 50 ## Next Steps 51 (No fixed timelines for these, depends on my time and motivation) 52 - [x] Publish v1 to Melpa. 53 --- 54 - [x] Add more screenshots showing off different modes (particularly markdown) 55 - [x] Evaluate & test github flavoured markdown in markdown-mode. 56 - [x] Publish v2 to Melpa 57 --- 58 - [x] Create a poet-dark mode with a yellow/white/black scheme. 59 - [ ] Add a dark brown theme 60 - [ ] Add support for customizing font faces 61 - [ ] Document support for additional modes. 62 - [ ] Publish v3 to Melpa. 63 64 65 ## More Screenshots 66 ![Org](https://github.com/kunalb/poet/raw/master/org.png) 67 ![Markdown 1](https://github.com/kunalb/poet/raw/master/md1.png) 68 ![Markdown 2](https://github.com/kunalb/poet/raw/master/md2.png)