Skip to content

Commit

Permalink
README updates from this branch
Browse files Browse the repository at this point in the history
  • Loading branch information
titaniumbones committed Jun 27, 2017
1 parent 6b40def commit e777653
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.org
Expand Up @@ -12,8 +12,6 @@ What this package is planned to do --

At present this project consists of the following files:

- =ox-blackfriday.el=: a derived backend that exports to the blackfriday markdown syntax, which Hugo uses as a basis
- =ox-hugo-helper.el=: collection of legacy functions gleaned from the web

This package might evolve into a multi-.el project.

Expand All @@ -25,22 +23,25 @@ This package might evolve into a multi-.el project.
- Set separate faces for titles based on /draft/ state and /futureness/.
- Option to use template =config.toml= and some default hugo theme. So all a new user would need to do is to (i) have the =hugo= binary in =PATH= (ii) define their =hugo= blog dir in the =defcustom= (iii) =M-x hugo=.

* TODO [0/12]
- [ ] Have =ox-hugo= be a backend derived from =ox-blackfriday= (=ox-blackfriday= needed at least for table support).
* TODO [1/8]
- [X] Have =ox-hugo= be a backend derived from =ox-blackfriday= (=ox-blackfriday= needed at least for table support).
- [ ] fix table horizontal rule generator, which currently adds an additional syntax-breaking space in each cell
- [ ] Parse org tags to set the hugo post tags/categories in fm.
- [ ] Parse org heading to set the hugo post title in fm.
- [ ] Use title to auto-generate file name string.
- [ ] Set post date to be the same as the export date *unless* =:PUBLISHDATE:= property exists.
- [ ] Ability to set/toggle =:DRAFT: true= in property drawer. Of course that should translate to hugo post fm.
- [ ] Parse org heading to set the hugo post title in fm
- [-] Clean up and formalize metadata fields
- [ ] Parse org tags to set the hugo post tags/categories in fm.
- [X] Use title to auto-generate file name string.
- [ ] Set post date to be the same as the export date *unless* =:PUBLISHDATE:= property exists.
- [ ] Ability to set/toggle =:DRAFT: true= in property drawer. Of course that should translate to hugo post fm.
- [ ] Function to re-export the whole org file to subtree-specific markdown files
- [ ] Use =org-capture= to generate new posts in a pre-defined "blog posts org file". That step should also auto-insert the meta-data needed for hugo frontmatter as needed -- like the post's initial /draft/ state.
- [ ] Different faces for the post heading based on its /draft/ state and /futureness/ (if /publishdate/ is newer than today).
- [ ] Different faces for the post heading based on its /draft/ state and /futureness/ (if /publishdate/ is newer than today). (this seems like a `hugo-minor-mode`. Seems cool to do, but maybe a separate project?
- [ ] Call =hugo= after each save.

* References
Currently the =ox-hugo.el= just contains slightly re-factored code snippets from the below 2 sources:
Currently the =ox-hugo-helper.el= just contains slightly re-factored code snippets from the below 2 sources:
- http://www.holgerschurig.de/en/emacs-blog-from-org-to-hugo/
- http://whyarethingsthewaytheyare.com/setting-up-the-blog/

Recently discovered https://github.com/helloyi/ox-hugo.
=ox-blackfriday.el= is a derived backend that exports to the blackfriday markdown syntax, which Hugo uses as a basis. Stolen from `ox-gfm.el`

=ox-hugo-helper.el= is a lightly-rewritten version of @helloyi's exporter: https://github.com/helloyi/ox-hugo.

0 comments on commit e777653

Please sign in to comment.