emacsite – easy Emacs web sites
Features
- Mobile-first Bootstrap design
- Easy Org-mode markup
- GNU Make site automation
- Elisp menu generation
- Free GitHub Pages hosting
- No Org Mode Publishing
- No Jekyll
Quick start
To create your own site at https://github.com/ yourname/yoursite
| Clone | git clone https://github.com/myglc2/emacsite.git yoursite && cd $_ && make repo |
| Start | make start |
| Build | make |
| Preview | make preview |
| Commit | make commit |
| Publish | make gh |
| Finish | make stop |
Embedded software by others
- ox-twbs.el Bootstrap export by Brandon van Beekum
- htmlize.el decorated font buffer export by Hrvoje Niksic
Required software
| Item | GuixSD 0.12.0 | macOS 10.12.3 + brew.sh | Debian 8 |
|---|---|---|---|
| GNU Emacs | 25.1.1 | 25.1.1 | 24.4.1 |
| Org-mode | 8.2.10 | 8.2.10 | 8.2.10 |
| GNU Make | 4.2 | 3.81 | 4.0 |
| curl | 7.52.1 | 7.51.0 | 7.43.0 |
| Git | 2.11.1 | 2.10.1 | 2.4.3 |
FAQ
Q: How does it work?
A: Please read makefile and header.org
Q: Why doesn't make preview open the site or run the browser I want?
A: Please edit makefile and set BROWSER := to run the browser you like
Q: Why am I getting 404's
A: For unknown reasons GitHub sometimes fails to update the site or a
page. You can push the whole site again with touch index.org && make
gh. If just one page is affected, you can do ~ git checkout
gh-pages~, make a trivial change, commit, and push.
Q: How do I change the code highlight colors?
A: Try M-x load-theme ?
Q: How do I delete a <page>?
A: Delete <page>.org and remove references to <page>.html from the
menu section of header.org and remove references, if any, to
<page>.org from makefile
Q: How do I add a <newpage>?
A: Create <newpage>.org and add references to <newpage>.html in
the menu section of header.org. If newpage.org includes .org files
besides header.org, (e.g. myinclude.org) then add a rule to the makefile
like
newpage.html: myinclude.org