Skip to content

eddieh/stix-org

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

STIX Org

 unofficial Scientific and Technical Information Exchange (STIX) theme for Org HTML exporter.

I made this theme for the same reason the STIX font exists. The theme is “intended to meet the demanding needs of authors, [developers, readers, …] and others in the scientific, medical, and technical fields.”

The STIX theme uses the STIX Fonts for body text and the DejaVu Sans Mono font for code. The fonts were selected because of their comprehensive Unicode coverage. The theme incorporates elements from the Lanyon for Jekyll theme, the OrgCSS stylesheet for Org’s HTML exporter, and many other sources of beautiful minimalist documents.

The theme also uses KaTeX over MathJax. The reason is simple, MathJax is big, slow—and hijacks your context menu. When a page uses MathJax, you know it. The software that renders the math should be unseen to the reader.

Check out the screenshots below or visit the example document exported with this theme.

img/code-blocks-and-formatting-600w.png

img/math-and-images-600w.png

Usage

Add these lines to your Emacs init file

(setq org-html-htmlize-output-type 'css)
(setq org-html-toplevel-hlevel 1)

Copy the setup file setup.org, the css/stix-org.css, and css/htmlize-b16-ocean.css to your local machine. Adjust URL/paths in the setup file to point to your copies of stix-org.css and htmlize-b16-ocean.css as needed.

#+HTML_HEAD: <link rel="stylesheet" href="path-to/stix-org.css">
#+HTML_HEAD: <link rel="stylesheet" href="path-to/htmlize-b16-ocean.css">

Add the #+SETUPFILE: directive to the frontmatter of your Org documents and adjust the URL/path to point to your copy of the setup.org file as needed.

#+TITLE: STIX Org
#+DATE: 2020-01-30
# ...
#+SETUPFILE: path-to/setup.org

Now C-c C-e h o to export the Org file to HTML and open it in your default browser.

Requirements

Organization

The repo is a little crowded, but here is a rundown of the files and directories.

Theme files

The only files need to use the theme are the two CSS files from the css directory and the setup.org file.

  • css/htmlize-b16-ocean.css
  • css/stix-org.css
  • setup.org

Example document

The example document is an Org file that contains many features, structures, and markup supported by Org. The document is a good base for developing a theme and hopefully, others will use it as such.

  • example.org

View the exported example document using this theme here.

Git & GitHub stuff

Stuff the repository need and GitHub needs like the README and stuff for GitHub Pages.

  • docs/
  • img/
  • resources/
  • .gitattributes
  • .gitignore
  • README.org
  • todo.org

Build support

Right now the build support only builds the GitHub pages, but assuming there’s interest beyond my own 🤞, it will contain stuff to minify, package, and upload to a CDN, etc.

  • lisp/
  • Makefile
  • init.el

Credits

Made with ☕️ in Bellevue, WA by @haltingproblems.

License

Permissive MIT license.

About

Emacs Org-mode HTML exporter theme for scientific and technical documents and blogs

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published