https://github.com/coldnew/org-remark
remark.js wrapper for org-mode
https://github.com/coldnew/org-remark
Last synced: 4 months ago
JSON representation
remark.js wrapper for org-mode
- Host: GitHub
- URL: https://github.com/coldnew/org-remark
- Owner: coldnew
- Created: 2015-01-20T11:08:31.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-10-25T05:20:33.000Z (over 3 years ago)
- Last Synced: 2025-03-05T02:18:54.169Z (over 1 year ago)
- Language: Emacs Lisp
- Homepage:
- Size: 30.3 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## ox-remark.el
*Export org-mode to remark.js*
---
[](https://travis-ci.org/coldnew/org-remark)
[](http://www.gnu.org/licenses/gpl-3.0.txt)
### Customization Documentation
#### `org-remark-hlevel`
The minimum level of headings that should be grouped into vertical slides.
### Function and Macro Documentation
#### `(org-remark-headline HEADLINE CONTENTS INFO)`
Transcode a HEADLINE element from Org to Google I/O slides.
CONTENTS holds the contents of the headline. INFO is a plist
holding contextual information.
#### `(org-remark-example-block EXAMPLE-BLOCK CONTENTS INFO)`
Transcode EXAMPLE-BLOCK element into Markdown format.
CONTENTS is nil. INFO is a plist used as a communication
channel.
#### `(org-remark-src-block SRC-BLOCK CONTENTS INFO)`
Transcode a SRC-BLOCK element from Org to HTML.
CONTENTS holds the contents of the item. INFO is a plist holding
contextual information.
#### `(org-remark-section SECTION CONTENTS INFO)`
Transcode a SECTION element from Org to HTML.
CONTENTS holds the contents of the section. INFO is a plist
holding contextual information.
#### `(org-remark-inner-template CONTENTS INFO)`
Return body of document string after HTML conversion.
CONTENTS is the transcoded contents string. INFO is a plist
holding export options.
#### `(org-remark-export-as-html &optional ASYNC SUBTREEP VISIBLE-ONLYBODY-ONLY EXT-PLIST)`
Export is done in a buffer named "*Reamrk HTML Export*", which
will be displayed when `org-export-show-temporary-export-buffer`
is non-nil.
#### `(org-remark-export-to-html &optional ASYNC SUBTREEP VISIBLE-ONLYBODY-ONLY EXT-PLIST)`
Export current buffer to a HTML file.
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the `org-export-stack` interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don't export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "" and "" tags.
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Return output file's name.
#### `(org-remark-save)`
Saves the file and reloads in browser.
-----