scroll Github

Pages

Variables

In org documents users can define some variables to use it on templates or change some config for only this file.

Variable names are case insensitive.

NOTE: More variables will be added soon.

title

Can be used in templates.

Usage:


#+TITLE: Page Title

Date

Can be used in templates.

Usage:


#+DATE: 2020-01-01

Template

Template variable define template to be used for this page.

Usage:


#+TEMPLATE: my_template.html

Elements

Currently Scroll supports following org elements but new elements will be added.

How they look on the editor. (all commented)


# * header

# paragraph

# - list element
# - list element
#   - inner list element
#     - inner list element
#       - inner list element
#     - inner list element
#   - inner list element
# - list element
#   paragraph under list element
# - list element

# #+BEGIN_SRC
# code
# snipet
# block
# #+END_SRC

# #+BEGIN_QUOTE
# quote block
# #+END_QUOTE

# BEGIN_HTML is a scroll specific block and its embed html directly to page.
# #+BEGIN_HTML
# <iframe width="420" height="315"
#   src="https://www.youtube.com/embed/tgbNymZ7vqY"
#   allowfullscreen="allowfullscreen">
# </iframe>
# #+END_HTML

# *bold* /italic/ +strikethrough+ _underline_ ~code~ [[https://github.com/metinur/scroll][link]]

# Org-mode has not different syntax for images, if a link ends with img tag supported
# file extension it becomes img automaticaly

# [[../logo.png]]

How they look on browser:

header

paragraph

  • list element
  • list element
    • inner list element
      • inner list element
        • inner list element
      • inner list element
    • inner list element
  • list element
  • paragraph under list element

  • list element

code
snipet
block

quote block

BEGIN_HTML is a scroll specific block and its embed html directly to page.

bold italic strikethrough underline code link

Org-mode has not different syntax for images, if a link ends with img tag supported file extension it becomes img automaticaly

img