Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fniessen/org-html-themes

Transform your Org mode files into stunning HTML documents in minutes with our Org mode HTML theme. Elevate your productivity and impress your readers! #orgmode #html #theme #productivity #design
https://github.com/fniessen/org-html-themes

Last synced: about 2 months ago
JSON representation

Transform your Org mode files into stunning HTML documents in minutes with our Org mode HTML theme. Elevate your productivity and impress your readers! #orgmode #html #theme #productivity #design

Host: GitHub
URL: https://github.com/fniessen/org-html-themes
Owner: fniessen
License: gpl-3.0
Created: 2014-09-13T12:56:19.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2024-05-19T20:02:14.000Z (7 months ago)
Last Synced: 2024-05-19T21:21:45.040Z (7 months ago)
Language: CSS
Homepage:
Size: 1.18 MB
Stars: 2,167
Watchers: 61
Forks: 424
Open Issues: 46
Metadata Files:
- Readme: README.org
- License: LICENSE.org

Awesome Lists containing this project

my-awesome-github-stars - fniessen/org-html-themes - Transform your Org mode files into stunning HTML documents in minutes with our Org mode HTML theme. Elevate your productivity and impress your readers! #orgmode #html #theme #productivity #design (CSS)

README

#+TITLE: How to effortlessly transform your Org mode files into stunning HTML in just 2 minutes
#+AUTHOR: Fabrice Niessen
#+EMAIL: (concat "fniessen" at-sign "pirilampo.org")
#+DESCRIPTION: Org-HTML export made simple.
#+KEYWORDS: org-mode, export, html, theme, style, css, js, bigblow
#+LANGUAGE: en
#+OPTIONS: H:4 toc:t num:2

#+PROPERTY: header-args :padline no
#+SETUPFILE: ~/org/theme-readtheorg.setup

#+html:
#+html: :license-gpl-blue.svg
#+html:
#+html:
#+html:
#+html:

#+begin_quote
[!TIP]

*** Elevate your Emacs skills in Paris, Utrecht, Leuven or Valencia!
*Unlock the power of Emacs! Join my next exclusive "Emacs Boost" course!*

Ready to /supercharge your productivity/ and become an Emacs ninja? Look no
further!

*What you'll learn:*
- Master Emacs from the basics to advanced tricks.
- /Boost your editing efficiency/ and streamline your workflow.
- Customize Emacs to fit your unique needs.
- And much more!

*Audience:*

Open to anyone interested in Emacs, from beginners to advanced
users.

*Why choose my course?*
- Expert instructor with 25 years of Emacs experience.
- /Hands-on exercises/ to reinforce your learning.
- /Networking opportunities/ with like-minded Emacs enthusiasts.
- Personalized attention.

Don't miss this opportunity to take your Emacs skills to the next level! \\

Visit https://emacsboost.com/en/ for more information, dates and locations, and
to /reserve your seat/.
#+end_quote

* Overview

** Description

Though you can easily override CSS stylesheets and add your own HTML themes, we
can say (or write) that Org mode provides a /basic/ HTML support.

*Org-HTML themes* is an open source framework for providing you with a list of
very nice (cross-browser) themes for all your Org documents. Use them to *style
your docs*, and your colleagues will come up to tell you that you are a genius!

Share this content by tweeting this page:

#+html:
#+html: Tweet

Follow [[https://twitter.com/f_niessen][f_niessen]] on Twitter for updates on Org-HTML themes!

** Requirements

Org mode version 8 (or later) is required.

If such a version is not bundled with your Emacs, install one from ELPA.

* Gallery
:PROPERTIES:
:ID: 79e0ed21-c3b0-4f00-bdab-29fbff9dcad4
:END:

This is a list of available *HTML themes for Org mode*, which you can use right
now!

** Bigblow

Bigblow is perfect for your work: it is a clean design aimed at optimal *Org
mode experience in your browser*. It looks just awesome!

#+ATTR_HTML: :width 640
[[https://www.youtube.com/watch?v=DnSGSiXYuOk][file:docs/bigblow.png]]

Click on the image for a quick [[https://www.youtube.com/watch?v=DnSGSiXYuOk][demo of Bigblow]] (2:49 min, no audio).

Keyboard shortcuts to save time and boost your productivity:

| Shortcut | What it does |
|----------+-----------------------------------|
| =?= or =h= | Access the *dashboard* |
| =n= | Move to the *next* main heading |
| =p= | Move to the *previous* main heading |
| =b= | Scroll up |
| =<= | Scroll to top |
| =>= | Scroll to bottom |
| =-= | Collapse all |
| =+= | Expand all |
| =r= | Go to next task in list |
| =R= | Go to previous task in list |
| =q= | Stop reviewing the list of tasks |
| =g= | Reload the page |

*** Quotations about Bigblow

"Very very nice, I enjoy it a lot." \\
-- /Ista Zahn/

"This is awesome. I love it!" \\
-- /Rainer M Krug/

"This is awesome!!" \\
-- /Mehul Sanghvi/

"This very nice html theme. [...] I cannot use another emacs-theme than your
[[https://github.com/fniessen/emacs-leuven-theme][emacs-leuven-theme]], and it is going to be probably the same with your html
theme!" \\
-- /Joseph Vidal-Rosset/

"Thanks a lot for sharing [...] the wonderful Bigblow theme. I create lot of
specification for other team members to use. It has always been a trouble to
share and maintain such spec. Now, I can create a much neater spec which is
available for the team's reference as a webpage." \\
-- /Shankar R./

"I like Bigblow the best. I've exported most of my Org files using this theme
and published them within my company's intranet. Thanks for sharing this
wonderful package!" \\
-- /Richard K./

** ReadTheOrg

ReadTheOrg is a clone of the official -- and great! -- [[https://github.com/snide/sphinx_rtd_theme][Sphinx theme]] used in the
[[http://docs.readthedocs.org/en/latest/][Read The Docs]] site. It gives a beautiful and professional style to all your Org
docs.

*Thanks to its creator(s)!*

#+ATTR_HTML: :width 640
[[file:docs/readtheorg.png]]

#+begin_note
While the original theme shines on mobile devices as well, ReadTheOrg does not
stay completely functional.

I don't have a lot of time to maintain this project due to other
responsibilities. Help is welcome to work on that (and eventually improve the
default structure of the HTML export)!
#+end_note

*** Quotations about ReadTheOrg

"OMG. The ReadTheOrg theme for exported HTML from org mode files is eye
wateringly beautiful. Thank you!" \\
-- /Rob Stewart/

"It is fantastic, so beautiful. I will switch several of my pages over to
this theme." \\
-- /Carsten D./

"That is incredibly impressive. Thanks for this." \\
-- /Noah R./

"Thank you! I enjoy your themes. The best ones I've ever found." \\
-- /Kang T./

"Awesome theme. Wonderful job. You're doing a wonderful thing --- it will
enable people (at least those who use Emacs and Org mode) to put together
on-line reference works in a much-more usable fashion than is currently
available." \\
-- /D. C. Toedt/

"Extremely useful." \\
-- /Thomas S. Dye/

"This is amazing, I've been looking for something like this for a LONG time!
I will share." \\
-- /Edward H./

* Demo

I've written a [[file:tests/org-mode-syntax-example.org][demo page]] for the themes that provides a maximal working support
of Org mode syntax.

Please see the [[https://github.com/fniessen/refcard-org-mode][Org mode refcard]] page for full examples of headings, code,
admonitions, footnotes, tables and other details.

* Using a theme

Using a theme from the [[id:79e0ed21-c3b0-4f00-bdab-29fbff9dcad4][theme gallery]] for your own Org documents is very easy:

1. You *add a* =#+SETUPFILE:= *directive* in the preamble of your document (to include
the necessary CSS and JavaScript files).

You can either use an URL of the following type for the "setup file" of your
chosen theme:

#+begin_src org :exports code
,#+SETUPFILE: https://fniessen.github.io/org-html-themes/org/theme-NAME.setup
#+end_src

(where ~NAME~ is either ~bigblow~ or ~readtheorg~)

or, if you *cloned or downloaded* the Org-HTML themes project -- to get no
dependency on an Internet connection --, use a (relative or absolute) path to
the /local/ "setup file" and copy the =src= folder from the cloned folder
into the same folder as the file you want to export:

#+begin_src org :exports code
,#+SETUPFILE: PATH/TO/GIT/REPO/org/theme-NAME-local.setup
#+end_src

2. Then, you *export* your Org mode file *to HTML* with =org-html-export-to-html= or
with =C-c C-e h h=.

* Customizing a theme

You love those themes, but you still would like to override particular HTML
tags? Some examples do follow...

Before doing that, though, if you think it really is an improvement that could
serve other persons as well, including me, you're invited to submit your
change...

** Change the background code blocks

Here's an example to insert into your Org documents:

#+begin_src org :tangle no
# Change the background of source block.
,#+HTML_HEAD: pre.src{background:#343131;color:white;}
#+end_src

** Unset body width limit of ReadTheOrg

Solution provided by Malcolm Cook:

#+begin_src org :tangle no
,#+HTML_HEAD: #content{max-width:1800px;}
,#+HTML_HEAD: p{max-width:800px;}
,#+HTML_HEAD: li{max-width:800px;}
#+html: :license-gpl-blue.svg
#+html:
#+html:
#+html:
#+html: