Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/b-coimbra/org-scribbler-theme

Theme for org-mode HTML export
https://github.com/b-coimbra/org-scribbler-theme

emacs org-mode

Last synced: 4 months ago
JSON representation

Theme for org-mode HTML export

Awesome Lists containing this project

README

        

#+TITLE: Scribbler Theme

Dark theme for org-mode HTML exports.

[[https://i.imgur.com/71uR2V6.png]]

Preview: [[https://wiki.metaphoric.dev][https://wiki.metaphoric.dev]]

* Usage

Import scribbler into your .org file by adding the following line in the header:
#+begin_src org
,#+setupfile: https://b-coimbra.github.io/org-scribbler-theme/scribbler.setup
#+end_src

Then export the file by using =C-c C-e #= or =M-x org-export-dispatch=

** Subtitle

Subtitles can be added with the following tag:

#+begin_src org
,#+subtitle: Some subtitle
#+end_src

** Tags

Tags can be added by creating a =tags.json= file in the root of your .html files.

Example:

#+begin_src json
{
"tags": [
{
"name": "git",
"color": "#9c6464",
"files": ["git-hooks", "git"]
},
{
"name": "automation",
"files": ["git-hooks"]
},
{
"name": "linux",
"color": "#C95C70"
"files": ["linux", "tmux", "ssh"]
},
{
"name": "tools",
"color": "#36194C",
"files": ["tmux", "ssh", "docker", "git"]
}
]
}
#+end_src

** Example configuration

#+begin_src org
,#+TITLE: Angular @framework
,#+SUBTITLE: Angular is a platform for building mobile and desktop web applications.
,#+DATE: <2021-09-11 Sat>
,#+AUTHOR: Bruno Coimbra (b-coimbra)
,#+EMAIL: [email protected]
,#+SETUPFILE: https://b-coimbra.github.io/org-scribbler-theme/scribbler.setup
#+end_src