Add Meta Features section in README

master
Kaushal Modi 9 years ago
parent 5ec15d4376
commit 9f062aeeb4
  1. 26
      README.org
  2. 28
      doc/ox-hugo-manual.org
  3. 2
      doc/ox-hugo.wiki

@ -28,11 +28,21 @@ seeing live-preview of the Hugo-rendered HTML each time you do =C-x
C-s= in the Org file --- For now, this works only with the *Subtree
export flow*.
* Demo
#+BEGIN_CENTER
[[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content-org][Org source]] → [[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content][Exported Markdown]] → [[https://ox-hugo.netlify.com][Hugo published site -- https://ox-hugo.netlify.com]]
#+END_CENTER
[[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content-org][Org source]] → [[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content][Exported Markdown]] → [[https://ox-hugo.netlify.com][*Hugo published site*]]
The demo site doesn't look pretty, I know .. because:
- It is designed to verify if all the content translates from Org to
Markdown as expected.
- It uses a [[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/themes/bare_min/][*bare_min*]] /theme/ written just for the debug purpose (not
presentation).
/See [[https://themes.gohugo.io/][Hugo Themes]] for examples of really good site prettification and
presentation styles./
* Documentation
See this README and the [[https://github.com/kaushalmodi/ox-hugo/wiki][*Wiki*]] for more!
* Table of Contents
- [[#demo][Demo]]
- [[#documentation][Documentation]]
- [[#screenshots][Screenshots]]
- [[#why-ox-hugo][Why =ox-hugo=?]]
- [[#installation][Installation]]
@ -48,6 +58,7 @@ export flow*.
- [[#for-complete-file-exports-c-c-c-e-h-h][For complete-file exports (=C-c C-e H h=)]]
- [[#formatting][Formatting]]
- [[#do-i-need-to-re-write-my-whole-blog-in-org][Do I need to re-write my whole blog in Org?]]
- [[#meta-features][Meta Features]]
- [[#changelog][Changelog]]
- [[#debug][Debug]]
- [[#test][Test]]
@ -314,6 +325,15 @@ necessity if you want to start using =ox-hugo=.
.. And if at some point, you want to stop using =ox-hugo=, you still
have the exported Markdown files.
* Meta Features
- =[✓]= Extensive tests! -- [[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content-org][test/example-site/content-org]]
- =[✓]= Travis CI Integration -- Checks with emacs versions starting from
24.4->25.2, with the latest stable version of =org-plus-contrib=.
- =[✓]= Demo site ([[https://ox-hugo.netlify.com/]]) -- Regenerated after
each commit to this repo
- =[✓]= Documentation -- README, Changelog, Wiki *all* generated from a
single [[https://github.com/kaushalmodi/ox-hugo/raw/master/doc/ox-hugo-manual.org][ox-hugo-manual.org]]
- =[✓]= Passes =checkdoc= and =package-lint= ([[https://github.com/purcell/package-lint/issues/89][/almost/]]).
* Changelog
** 0.1.3 <2017-09-13 Wed>
- Now a HUGO key value set to ="nil"=, like =#+HUGO_CODE_FENCE: nil=,

@ -111,9 +111,18 @@ seeing live-preview of the Hugo-rendered HTML each time you do =C-x
C-s= in the Org file --- For now, this works only with the *Subtree
export flow*.
** Demo
#+BEGIN_CENTER
[[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content-org][Org source]] → [[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content][Exported Markdown]] → [[https://ox-hugo.netlify.com][Hugo published site -- https://ox-hugo.netlify.com]]
#+END_CENTER
[[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content-org][Org source]] → [[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content][Exported Markdown]] → [[https://ox-hugo.netlify.com][*Hugo published site*]]
The demo site doesn't look pretty, I know .. because:
- It is designed to verify if all the content translates from Org to
Markdown as expected.
- It uses a [[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/themes/bare_min/][*bare_min*]] /theme/ written just for the debug purpose (not
presentation).
/See [[https://themes.gohugo.io/][Hugo Themes]] for examples of really good site prettification and
presentation styles./
** Documentation
See this README and the [[https://github.com/kaushalmodi/ox-hugo/wiki][*Wiki*]] for more!
** Table of Contents :TOC:
# TOC will be inserted here by `toc-org' package when running
# `ox-hugo-export-gh-doc'.
@ -399,6 +408,19 @@ necessity if you want to start using =ox-hugo=.
.. And if at some point, you want to stop using =ox-hugo=, you still
have the exported Markdown files.
** Meta Features :wiki:
:PROPERTIES:
:EXPORT_TITLE:
:EXPORT_FILE_NAME: Meta Features
:END:
- =[✓]= Extensive tests! -- [[https://github.com/kaushalmodi/ox-hugo/tree/master/test/example-site/content-org][test/example-site/content-org]]
- =[✓]= Travis CI Integration -- Checks with emacs versions starting from
24.4->25.2, with the latest stable version of =org-plus-contrib=.
- =[✓]= Demo site ([[https://ox-hugo.netlify.com/]]) -- Regenerated after
each commit to this repo
- =[✓]= Documentation -- README, Changelog, Wiki *all* generated from a
single [[https://github.com/kaushalmodi/ox-hugo/raw/master/doc/ox-hugo-manual.org][ox-hugo-manual.org]]
- =[✓]= Passes =checkdoc= and =package-lint= ([[https://github.com/purcell/package-lint/issues/89][/almost/]]).
** Changelog :wiki:noexport_1:
:PROPERTIES:
:EXPORT_TITLE:

@ -1 +1 @@
Subproject commit 2704215663199bd10adb6dec91e2a3d25f6073c0
Subproject commit f4beefefb3e5ca2e3adb3360b84d72ffb6567868
Loading…
Cancel
Save