Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add note on how to enable this package in Spacemacs
Browse files Browse the repository at this point in the history
Fixes #82
kaushalmodi committed Oct 9, 2017
1 parent 98346ca commit 0f6cb48
Showing 4 changed files with 95 additions and 13 deletions.
26 changes: 23 additions & 3 deletions README.org
Original file line number Diff line number Diff line change
@@ -80,9 +80,10 @@ presentation styles./
This package requires emacs 24.5+ and Org 9.0+. It is available on
Melpa ([[https://melpa.org/#/ox-hugo]]).
* Usage
Once the package is installed, you will need to require it so that the
=ox-hugo= export options are available in the /Org Export Dispatcher/
menu (the one you see when you hit =C-c C-e= to initiate any export).
Once the package is installed, you will need to /require/ it so that
the =ox-hugo= export options are available in the /Org Export
Dispatcher/ menu (the one you see when you hit =C-c C-e= to initiate
any export).

You can do that by adding the below to your config:
#+BEGIN_SRC emacs-lisp
@@ -94,6 +95,25 @@ If you use =use-package=, you can do the below instead:
(use-package ox-hugo
:after ox)
#+END_SRC

*Spacemacs*

Spacemacs users can choose to add this snippet to their
=dotspacemacs/user-config= function in =.spacemacs=:

#+BEGIN_SRC emacs-lisp
(defun dotspacemacs/user-config ()
;; Other stuff
;; ..

;; ox-hugo config
(use-package ox-hugo
:ensure t ;Auto-install the package from Melpa
:after ox))
#+END_SRC
/Verified to work on Spacemacs =develop= branch with =spacemacs-base=
distribution, =emacs= editing style, and =org= added to
=dotspacemacs-configuration-layers=./
** Before you export
Before you export check that these properties are set as you need:
- HUGO_SECTION :: The default Hugo section name for all the posts. See
27 changes: 24 additions & 3 deletions doc/content/_index.md
Original file line number Diff line number Diff line change
@@ -80,9 +80,10 @@ Melpa (<https://melpa.org/#/ox-hugo>).

## Usage {#usage}

Once the package is installed, you will need to require it so that the
`ox-hugo` export options are available in the _Org Export Dispatcher_
menu (the one you see when you hit `C-c C-e` to initiate any export).
Once the package is installed, you will need to _require_ it so that
the `ox-hugo` export options are available in the _Org Export
Dispatcher_ menu (the one you see when you hit `C-c C-e` to initiate
any export).

You can do that by adding the below to your config:

@@ -98,6 +99,26 @@ If you use `use-package`, you can do the below instead:
:after ox)
```

**Spacemacs**

Spacemacs users can choose to add this snippet to their
`dotspacemacs/user-config` function in `.spacemacs`:

```emacs-lisp
(defun dotspacemacs/user-config ()
;; Other stuff
;; ..
;; ox-hugo config
(use-package ox-hugo
:ensure t ;Auto-install the package from Melpa
:after ox))
```

_Verified to work on Spacemacs `develop` branch with `spacemacs-base`
distribution, `emacs` editing style, and `org` added to
`dotspacemacs-configuration-layers`._


### Before you export {#before-you-export}

27 changes: 24 additions & 3 deletions doc/content/doc/usage.md
Original file line number Diff line number Diff line change
@@ -6,9 +6,10 @@ draft = false
identifier = "usage"
+++

Once the package is installed, you will need to require it so that the
`ox-hugo` export options are available in the _Org Export Dispatcher_
menu (the one you see when you hit `C-c C-e` to initiate any export).
Once the package is installed, you will need to _require_ it so that
the `ox-hugo` export options are available in the _Org Export
Dispatcher_ menu (the one you see when you hit `C-c C-e` to initiate
any export).

You can do that by adding the below to your config:

@@ -24,6 +25,26 @@ If you use `use-package`, you can do the below instead:
:after ox)
```

**Spacemacs**

Spacemacs users can choose to add this snippet to their
`dotspacemacs/user-config` function in `.spacemacs`:

```emacs-lisp
(defun dotspacemacs/user-config ()
;; Other stuff
;; ..
;; ox-hugo config
(use-package ox-hugo
:ensure t ;Auto-install the package from Melpa
:after ox))
```

_Verified to work on Spacemacs `develop` branch with `spacemacs-base`
distribution, `emacs` editing style, and `org` added to
`dotspacemacs-configuration-layers`._


## Before you export {#before-you-export}

28 changes: 24 additions & 4 deletions doc/ox-hugo-manual.org
Original file line number Diff line number Diff line change
@@ -108,13 +108,14 @@ many other tweaks. =ox-hugo= backend extends from this.
:END:
This package requires emacs 24.5+ and Org 9.0+. It is available on
Melpa ([[https://melpa.org/#/ox-hugo]]).
** Usage
** COMMENT Usage
:PROPERTIES:
:CUSTOM_ID: usage
:END:
Once the package is installed, you will need to require it so that the
=ox-hugo= export options are available in the /Org Export Dispatcher/
menu (the one you see when you hit =C-c C-e= to initiate any export).
Once the package is installed, you will need to /require/ it so that
the =ox-hugo= export options are available in the /Org Export
Dispatcher/ menu (the one you see when you hit =C-c C-e= to initiate
any export).

You can do that by adding the below to your config:
#+BEGIN_SRC emacs-lisp
@@ -126,6 +127,25 @@ If you use =use-package=, you can do the below instead:
(use-package ox-hugo
:after ox)
#+END_SRC

*Spacemacs*

Spacemacs users can choose to add this snippet to their
=dotspacemacs/user-config= function in =.spacemacs=:

#+BEGIN_SRC emacs-lisp
(defun dotspacemacs/user-config ()
;; Other stuff
;; ..

;; ox-hugo config
(use-package ox-hugo
:ensure t ;Auto-install the package from Melpa
:after ox))
#+END_SRC
/Verified to work on Spacemacs =develop= branch with =spacemacs-base=
distribution, =emacs= editing style, and =org= added to
=dotspacemacs-configuration-layers=./
*** Before you export
:PROPERTIES:
:CUSTOM_ID: before-you-export

0 comments on commit 0f6cb48

Please sign in to comment.