diff --git a/README.org b/README.org
index 0520390..09fdbdc 100644
--- a/README.org
+++ b/README.org
@@ -46,6 +46,32 @@ There is a plan to create a =hugo.el= that would do things like:
- Set separate faces for titles based on /draft/ state and
/futureness/.
+* Formatting
+Below table shows the translation of Org markup to Markdown markup in
+the exported =.md= files.
+
+See the Org source in [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/example-site/content-org/all-posts.org][=all-posts.org=]] under /Formatting/ -> /General/
+heading and how it exports to Markdown in [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/example-site/content/posts/general-formatting.md][=general-formatting.md=]].
+|--------------------+--------------------------------------------------------------------|
+| Org | Markdown |
+|--------------------+--------------------------------------------------------------------|
+| =*bold*= | =**bold**= |
+| =/italics/= | =_italics_= |
+| ==monospace== | =`monospace`= |
+| =~key-binding~= | =key-binding= |
+| | - if =org-hugo-use-code-for-kbd= is non-nil [default] |
+| | - Requires *CSS* to render the == tag as something special. |
+| =~key-binding~= | =`key-binding`= |
+| | - if =org-hugo-use-code-for-kbd= is nil |
+| =+strike-through+= | =~~strike-through~~= |
+| =_underline_= | =underline= |
+| | - Requires *CSS* to render this =underline= class as an underline. |
+|--------------------+--------------------------------------------------------------------|
+
+(Note: If you see two equal signs on each side of /monospace/ in the
+/Org/ column in the table above, it is a bug with GitHub's Org
+renderer.. just see those as *single* equal signs on each side of
+/monospace/ instead.)
* Example Hugo site to test this package
A little [[https://github.com/kaushalmodi/ox-hugo/tree/master/example-site][example-site]] with bare-bones "theme" is used to live-test the
package (you'll know why theme is double-quoted once you try out the
@@ -111,7 +137,6 @@ translate to Hugo front matter:
| =draft = true= | =* TODO foo= | Heading set to TODO (or DRAFT) |
| =draft = false= | =* foo= | Heading *not* set to TODO (or DRAFT) |
|---------------------------+----------------------------+--------------------------------------|
-
* Try =ox-hugo=
1. Clone this repo.
2. Run =hugo server --buildDrafts --buildFuture --navigateToChanged= in
diff --git a/example-site/content-org/all-posts.org b/example-site/content-org/all-posts.org
index f646898..bf5f160 100644
--- a/example-site/content-org/all-posts.org
+++ b/example-site/content-org/all-posts.org
@@ -352,6 +352,71 @@ property needs to be left *empty* instead of setting to =nil=!
#+BEGIN_SRC makefile
prefix = /dir/where/you/want/to/install/org # Default: /usr/share
#+END_SRC
+* Formatting :formatting:
+** General
+:PROPERTIES:
+:EXPORT_DATE: 2017-07-31
+:EXPORT_FILE_NAME: general-formatting
+:END:
+Below table shows the translation of Org markup to Markdown markup in
+the exported =.md= files.
+|--------------------+--------------------------------------------------------------------+-----------------------|
+| Org | Markdown | In Hugo rendered HTML |
+|--------------------+--------------------------------------------------------------------+-----------------------|
+| =*bold*= | =**bold**= | *bold* |
+| =/italics/= | =_italics_= | /italics/ |
+| ==monospace== | =`monospace`= | =monospace= |
+| =~key-binding~= | =key-binding= | ~key-binding~ |
+| | - if =org-hugo-use-code-for-kbd= is non-nil [default] | |
+| | - Requires *CSS* to render the == tag as something special. | |
+| =~key-binding~= | =`key-binding`= | |
+| | - if =org-hugo-use-code-for-kbd= is nil | |
+| =+strike-through+= | =~~strike-through~~= | +strike-through+ |
+| =_underline_= | =underline= | _underline_ |
+| | - Requires *CSS* to render this =underline= class as an underline. | |
+|--------------------+--------------------------------------------------------------------+-----------------------|
+** Keyboard tag
+*** Use Org Code markup for =kbd= tag (default behavior)
+:PROPERTIES:
+:EXPORT_FILE_NAME: kbd-tag-default
+:EXPORT_DATE: 2017-07-31
+:END:
+This is the default behavior. So =~C-h f~= will show up as =C-h
+f=.
+
+Example:
+- Few of Emacs help keybindings: ~C-h f~, ~C-h v~
+*** Use Org Code markup for =kbd= tag
+:PROPERTIES:
+:EXPORT_HUGO_USE_CODE_FOR_KBD: t
+:EXPORT_FILE_NAME: kbd-tag-yes
+:EXPORT_DATE: 2017-07-31
+:END:
+Here the Org code markup is explicitly specified to be used for
+== tag generation by setting =EXPORT_HUGO_USE_CODE_FOR_KBD=
+property to =t=. So =~C-h f~= will show up as =C-h f=.
+
+Example:
+- Few of Emacs help keybindings: ~C-h f~, ~C-h v~
+*** Don't Use Org Code markup for =kbd= tag
+:PROPERTIES:
+:EXPORT_HUGO_USE_CODE_FOR_KBD:
+:EXPORT_FILE_NAME: kbd-tag-no
+:EXPORT_DATE: 2017-07-31
+:END:
+Note that to disable the "use code for kbd" option, the value portion
+of the property needs to be left *empty* instead of setting to =nil=!
+#+BEGIN_EXAMPLE
+:PROPERTIES:
+:EXPORT_HUGO_USE_CODE_FOR_KBD:
+:END:
+#+END_EXAMPLE
+
+Here =~C-h f~= will show up as =`C-h f`= in Markdown and then
+=C-h f= in the final Hugo generated HTML.
+
+Example:
+- Few of Emacs help keybindings: ~C-h f~, ~C-h v~
* Example block :example:
** Simple
:PROPERTIES:
@@ -596,48 +661,6 @@ This post is in category =catA= and tagged =meow=.
:EXPORT_DATE: 2017-07-24
:END:
This gets both categories =catA= and =catB=.
-* Keyboard tag
-** Use Org Code markup for =kbd= tag (default behavior)
-:PROPERTIES:
-:EXPORT_FILE_NAME: kbd-tag-default
-:EXPORT_DATE: 2017-07-31
-:END:
-This is the default behavior. So =~C-h f~= will show up as =C-h
-f=.
-
-Example:
-- Few of Emacs help keybindings: ~C-h f~, ~C-h v~
-** Use Org Code markup for =kbd= tag
-:PROPERTIES:
-:EXPORT_HUGO_USE_CODE_FOR_KBD: t
-:EXPORT_FILE_NAME: kbd-tag-yes
-:EXPORT_DATE: 2017-07-31
-:END:
-Here the Org code markup is explicitly specified to be used for
-== tag generation by setting =EXPORT_HUGO_USE_CODE_FOR_KBD=
-property to =t=. So =~C-h f~= will show up as =C-h f=.
-
-Example:
-- Few of Emacs help keybindings: ~C-h f~, ~C-h v~
-** Don't Use Org Code markup for =kbd= tag
-:PROPERTIES:
-:EXPORT_HUGO_USE_CODE_FOR_KBD:
-:EXPORT_FILE_NAME: kbd-tag-no
-:EXPORT_DATE: 2017-07-31
-:END:
-Note that to disable the "use code for kbd" option, the value portion
-of the property needs to be left *empty* instead of setting to =nil=!
-#+BEGIN_EXAMPLE
-:PROPERTIES:
-:EXPORT_HUGO_USE_CODE_FOR_KBD:
-:END:
-#+END_EXAMPLE
-
-Here =~C-h f~= will show up as =`C-h f`= in Markdown and then
-=C-h f= in the final Hugo generated HTML.
-
-Example:
-- Few of Emacs help keybindings: ~C-h f~, ~C-h v~
* Links :links:
** Within the same post
*** Link to a heading CUSTOM_ID
diff --git a/example-site/content/posts/general-formatting.md b/example-site/content/posts/general-formatting.md
new file mode 100644
index 0000000..e2b7b4d
--- /dev/null
+++ b/example-site/content/posts/general-formatting.md
@@ -0,0 +1,23 @@
++++
+title = "General"
+date = 2017-07-31
+tags = ["formatting"]
+draft = false
++++
+
+Below table shows the translation of Org markup to Markdown markup in
+the exported `.md` files.
+
+Org | Markdown | In Hugo rendered HTML
+-------------------|----------------------------------------------------------------------|-----------------------------------------
+`*bold*` | `**bold**` | **bold**
+`/italics/` | `_italics_` | _italics_
+`=monospace=` | `` `monospace` `` | `monospace`
+`~key-binding~` | `key-binding` | key-binding
+ | - if `org-hugo-use-code-for-kbd` is non-nil [default] |
+ | - Requires **CSS** to render the `` tag as something special. |
+`~key-binding~` | `` `key-binding` `` |
+ | - if `org-hugo-use-code-for-kbd` is nil |
+`+strike-through+` | `~~strike-through~~` | ~~strike-through~~
+`_underline_` | `underline` | underline
+ | - Requires **CSS** to render this `underline` class as an underline. |
diff --git a/example-site/content/posts/kbd-tag-default.md b/example-site/content/posts/kbd-tag-default.md
index 64a64f1..277e6fd 100644
--- a/example-site/content/posts/kbd-tag-default.md
+++ b/example-site/content/posts/kbd-tag-default.md
@@ -1,7 +1,7 @@
+++
title = "Use Org Code markup for kbd tag (default behavior)"
date = 2017-07-31
-tags = []
+tags = ["formatting"]
draft = false
+++
diff --git a/example-site/content/posts/kbd-tag-no.md b/example-site/content/posts/kbd-tag-no.md
index 8d16e1f..3f69b38 100644
--- a/example-site/content/posts/kbd-tag-no.md
+++ b/example-site/content/posts/kbd-tag-no.md
@@ -1,7 +1,7 @@
+++
title = "Don't Use Org Code markup for kbd tag"
date = 2017-07-31
-tags = []
+tags = ["formatting"]
draft = false
+++
diff --git a/example-site/content/posts/kbd-tag-yes.md b/example-site/content/posts/kbd-tag-yes.md
index d2dc623..e1ddb26 100644
--- a/example-site/content/posts/kbd-tag-yes.md
+++ b/example-site/content/posts/kbd-tag-yes.md
@@ -1,7 +1,7 @@
+++
title = "Use Org Code markup for kbd tag"
date = 2017-07-31
-tags = []
+tags = ["formatting"]
draft = false
+++