{"id":13442215,"url":"https://github.com/fniessen/org-html-themes","last_synced_at":"2025-03-20T13:32:59.892Z","repository":{"id":20710368,"uuid":"23994289","full_name":"fniessen/org-html-themes","owner":"fniessen","description":"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","archived":false,"fork":false,"pushed_at":"2024-05-19T20:02:14.000Z","size":1236,"stargazers_count":2167,"open_issues_count":46,"forks_count":424,"subscribers_count":61,"default_branch":"master","last_synced_at":"2024-05-19T21:21:45.040Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fniessen.png","metadata":{"files":{"readme":"README.org","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.org","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-09-13T12:56:19.000Z","updated_at":"2024-05-19T21:21:52.682Z","dependencies_parsed_at":"2024-03-30T13:48:46.379Z","dependency_job_id":null,"html_url":"https://github.com/fniessen/org-html-themes","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fniessen%2Forg-html-themes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fniessen%2Forg-html-themes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fniessen%2Forg-html-themes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fniessen%2Forg-html-themes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fniessen","download_url":"https://codeload.github.com/fniessen/org-html-themes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221768499,"owners_count":16877650,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T03:01:43.062Z","updated_at":"2025-03-20T13:32:59.886Z","avatar_url":"https://github.com/fniessen.png","language":"CSS","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=VCVAS6KPDQ4JC\u0026lc=BE\u0026item_number=org%2dhtml%2dthemes\u0026currency_code=EUR\u0026bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted"],"categories":["CSS"],"sub_categories":[],"readme":"#+TITLE:     How to effortlessly transform your Org mode files into stunning HTML in just 2 minutes\n#+AUTHOR:    Fabrice Niessen\n#+EMAIL:     (concat \"fniessen\" at-sign \"pirilampo.org\")\n#+DESCRIPTION: Org-HTML export made simple.\n#+KEYWORDS:  org-mode, export, html, theme, style, css, js, bigblow\n#+LANGUAGE:  en\n#+OPTIONS:   H:4 toc:t num:2\n\n#+PROPERTY:  header-args :padline no\n#+SETUPFILE: ~/org/theme-readtheorg.setup\n\n#+html: \u003ca href=\"http://opensource.org/licenses/GPL-3.0\"\u003e\n#+html:   \u003cimg src=\"http://img.shields.io/:license-gpl-blue.svg\" alt=\":license-gpl-blue.svg\" /\u003e\n#+html: \u003c/a\u003e\n#+html: \u003ca href=\"https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=VCVAS6KPDQ4JC\u0026lc=BE\u0026item_number=org%2dhtml%2dthemes\u0026currency_code=EUR\u0026bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted\"\u003e\n#+html:   \u003cimg src=\"https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif\" alt=\"btn_donate_LG.gif\" /\u003e\n#+html: \u003c/a\u003e\n\n#+begin_quote\n[!TIP]\n\n*** Elevate your Emacs skills in Paris, Utrecht, Leuven or Valencia!\n*Unlock the power of Emacs!  Join my next exclusive \"Emacs Boost\" course!*\n\nReady to /supercharge your productivity/ and become an Emacs ninja?  Look no\nfurther!\n\n*What you'll learn:*\n- Master Emacs from the basics to advanced tricks.\n- /Boost your editing efficiency/ and streamline your workflow.\n- Customize Emacs to fit your unique needs.\n- And much more!\n\n*Audience:*\n\nOpen to anyone interested in Emacs, from beginners to advanced\nusers.\n\n*Why choose my course?*\n- Expert instructor with 25 years of Emacs experience.\n- /Hands-on exercises/ to reinforce your learning.\n- /Networking opportunities/ with like-minded Emacs enthusiasts.\n- Personalized attention.\n\nDon't miss this opportunity to take your Emacs skills to the next level! \\\\\n\nVisit https://emacsboost.com/en/ for more information, dates and locations, and\nto /reserve your seat/.\n#+end_quote\n\n* Overview\n\n** Description\n\nThough you can easily override CSS stylesheets and add your own HTML themes, we\ncan say (or write) that Org mode provides a /basic/ HTML support.\n\n*Org-HTML themes* is an open source framework for providing you with a list of\nvery nice (cross-browser) themes for all your Org documents.  Use them to *style\nyour docs*, and your colleagues will come up to tell you that you are a genius!\n\nShare this content by tweeting this page:\n\n#+html: \u003cscript src=\"http://platform.twitter.com/widgets.js\"\u003e\u003c/script\u003e\n#+html: \u003ca href=\"https://twitter.com/share\" class=\"twitter-share-button\" data-via=\"f_niessen\"\u003eTweet\u003c/a\u003e\n\nFollow [[https://twitter.com/f_niessen][f_niessen]] on Twitter for updates on Org-HTML themes!\n\n** Requirements\n\nOrg mode version 8 (or later) is required.\n\nIf such a version is not bundled with your Emacs, install one from ELPA.\n\n* Gallery\n:PROPERTIES:\n:ID:       79e0ed21-c3b0-4f00-bdab-29fbff9dcad4\n:END:\n\nThis is a list of available *HTML themes for Org mode*, which you can use right\nnow!\n\n** Bigblow\n\nBigblow is perfect for your work: it is a clean design aimed at optimal *Org\nmode experience in your browser*.  It looks just awesome!\n\n#+ATTR_HTML: :width 640\n[[https://www.youtube.com/watch?v=DnSGSiXYuOk][file:docs/bigblow.png]]\n\nClick on the image for a quick [[https://www.youtube.com/watch?v=DnSGSiXYuOk][demo of Bigblow]] (2:49 min, no audio).\n\nKeyboard shortcuts to save time and boost your productivity:\n\n| Shortcut   | What it does                        |\n|------------+-------------------------------------|\n| =?= or =h= | Access the *dashboard*              |\n| =n=        | Move to the *next* main heading     |\n| =p=        | Move to the *previous* main heading |\n| =b=        | Scroll up                           |\n| =\u003c=        | Scroll to top                       |\n| =\u003e=        | Scroll to bottom                    |\n| =-=        | Collapse all                        |\n| =+=        | Expand all                          |\n| =r=        | Go to next task in list             |\n| =R=        | Go to previous task in list         |\n| =q=        | Stop reviewing the list of tasks    |\n| =g=        | Reload the page                     |\n\n*** Quotations about Bigblow\n\n\"Very very nice, I enjoy it a lot.\" \\\\\n-- /Ista Zahn/\n\n\"This is awesome.  I love it!\" \\\\\n-- /Rainer M Krug/\n\n\"This is awesome!!\" \\\\\n-- /Mehul Sanghvi/\n\n\"This very nice html theme. [...]  I cannot use another emacs-theme than your\n[[https://github.com/fniessen/emacs-leuven-theme][emacs-leuven-theme]], and it is going to be probably the same with your html\ntheme!\" \\\\\n-- /Joseph Vidal-Rosset/\n\n\"Thanks a lot for sharing [...] the wonderful Bigblow theme.  I create lot of\nspecification for other team members to use.  It has always been a trouble to\nshare and maintain such spec.  Now, I can create a much neater spec which is\navailable for the team's reference as a webpage.\" \\\\\n-- /Shankar R./\n\n\"I like Bigblow the best.  I've exported most of my Org files using this theme\nand published them within my company's intranet.  Thanks for sharing this\nwonderful package!\" \\\\\n-- /Richard K./\n\n** ReadTheOrg\n\nReadTheOrg is a clone of the official -- and great! -- [[https://github.com/snide/sphinx_rtd_theme][Sphinx theme]] used in the\n[[http://docs.readthedocs.org/en/latest/][Read The Docs]] site.  It gives a beautiful and professional style to all your Org\ndocs.\n\n*Thanks to its creator(s)!*\n\n#+ATTR_HTML: :width 640\n[[file:docs/readtheorg.png]]\n\n#+begin_note\nWhile the original theme shines on mobile devices as well, ReadTheOrg does not\nstay completely functional.\n\nI don't have a lot of time to maintain this project due to other\nresponsibilities.  Help is welcome to work on that (and eventually improve the\ndefault structure of the HTML export)!\n#+end_note\n\n*** Quotations about ReadTheOrg\n\n\"OMG.  The ReadTheOrg theme for exported HTML from org mode files is eye\nwateringly beautiful.  Thank you!\" \\\\\n-- /Rob Stewart/\n\n\"It is fantastic, so beautiful.  I will switch several of my pages over to\nthis theme.\" \\\\\n-- /Carsten D./\n\n\"That is incredibly impressive.  Thanks for this.\" \\\\\n-- /Noah R./\n\n\"Thank you!  I enjoy your themes.  The best ones I've ever found.\" \\\\\n-- /Kang T./\n\n\"Awesome theme.  Wonderful job.  You're doing a wonderful thing --- it will\nenable people (at least those who use Emacs and Org mode) to put together\non-line reference works in a much-more usable fashion than is currently\navailable.\" \\\\\n-- /D. C. Toedt/\n\n\"Extremely useful.\" \\\\\n-- /Thomas S. Dye/\n\n\"This is amazing, I've been looking for something like this for a LONG time!\nI will share.\" \\\\\n-- /Edward H./\n\n* Demo\n\nI've written a [[file:examples/org-mode-syntax-example.org][demo page]] for the themes that provides a maximal working support\nof Org mode syntax.\n\nPlease see the [[https://github.com/fniessen/refcard-org-mode][Org mode refcard]] page for full examples of headings, code,\nadmonitions, footnotes, tables and other details.\n\n* Using a theme\n\nUsing a theme from the [[id:79e0ed21-c3b0-4f00-bdab-29fbff9dcad4][theme gallery]] for your own Org documents is very easy:\n\n1. You *add a* =#+SETUPFILE:= *directive* in the preamble of your document (to include\n   the necessary CSS and JavaScript files).\n\n   You can either use an URL of the following type for the \"setup file\" of your\n   chosen theme:\n\n   #+begin_src org :exports code\n   ,#+SETUPFILE: https://fniessen.github.io/org-html-themes/org/theme-NAME.setup\n   #+end_src\n\n   (where ~NAME~ is either ~bigblow~ or ~readtheorg~)\n\n   or, if you *cloned or downloaded* the Org-HTML themes project -- to get no\n   dependency on an Internet connection --, use a (relative or absolute) path to\n   the /local/ \"setup file\" and copy the =src= folder from the cloned folder\n   into the same folder as the file you want to export:\n\n   #+begin_src org :exports code\n   ,#+SETUPFILE: PATH/TO/GIT/REPO/org/theme-NAME-local.setup\n   #+end_src\n\n2. Then, you *export* your Org mode file *to HTML* with =org-html-export-to-html= or\n   with =C-c C-e h h=.\n\n* Customizing a theme\n\nYou love those themes, but you still would like to override particular HTML\ntags?  Some examples do follow...\n\nBefore doing that, though, if you think it really is an improvement that could\nserve other persons as well, including me, you're invited to submit your\nchange...\n\n** Change the background code blocks\n\nHere's an example to insert into your Org documents:\n\n#+begin_src org :tangle no\n# Change the background of source block.\n,#+HTML_HEAD: \u003cstyle\u003epre.src{background:#343131;color:white;} \u003c/style\u003e\n#+end_src\n\n** Unset body width limit of ReadTheOrg\n\nSolution provided by Malcolm Cook:\n\n#+begin_src org :tangle no\n,#+HTML_HEAD: \u003cstyle\u003e #content{max-width:1800px;}\u003c/style\u003e\n,#+HTML_HEAD: \u003cstyle\u003e p{max-width:800px;}\u003c/style\u003e\n,#+HTML_HEAD: \u003cstyle\u003e li{max-width:800px;}\u003c/style\n#+end_src\n\n* Contribute to the project!\n\n** Report issues and enhancements\n\nFound a bug or have an idea for a new feature?  Share your thoughts on the\n[[https://github.com/fniessen/org-html-themes/issues/new][GitHub issue tracker]].\n\n** Submit patches\n\nI welcome contributions in any form!  Feel free to submit patches to enhance the\nproject.\n\n** Support development with a donation!\n\nIf you find the \"org-html-themes\" project (or any of [[https://github.com/fniessen/][my other projects]])\nenhancing your Emacs experience and simplifying your workflow, seize the\nopportunity to express your appreciation!  Help fuel future development by\nmaking a [[https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=VCVAS6KPDQ4JC\u0026lc=BE\u0026item_number=org%2dhtml%2dthemes\u0026currency_code=EUR\u0026bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted][donation]] through PayPal. Your support is invaluable -- thank you!\n\nRemember, regardless of donations, \"org-html-themes\" will always remain freely\naccessible, both as in Belgian beer and as in speech.\n\n* License\n\nCopyright (C) 2011-2025 Fabrice Niessen. All rights reserved.\n\nAuthor: Fabrice Niessen \\\\\nKeywords: org-mode html themes\n\nThis program is free software; you can redistribute it and/or modify it under\nthe terms of the GNU General Public License as published by the Free Software\nFoundation, either version 3 of the License, or (at your option) any later\nversion.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR\nA PARTICULAR PURPOSE.  See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with\nthis program.  If not, see http://www.gnu.org/licenses/.\n\n#+html: \u003ca href=\"http://opensource.org/licenses/GPL-3.0\"\u003e\n#+html:   \u003cimg src=\"http://img.shields.io/:license-gpl-blue.svg\" alt=\":license-gpl-blue.svg\" /\u003e\n#+html: \u003c/a\u003e\n#+html: \u003ca href=\"https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=VCVAS6KPDQ4JC\u0026lc=BE\u0026item_number=org%2dhtml%2dthemes\u0026currency_code=EUR\u0026bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted\"\u003e\n#+html:   \u003cimg src=\"https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif\" alt=\"btn_donate_LG.gif\" /\u003e\n#+html: \u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffniessen%2Forg-html-themes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffniessen%2Forg-html-themes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffniessen%2Forg-html-themes/lists"}