You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
72 lines
2.9 KiB
72 lines
2.9 KiB
#+title: GitHub Ancillary Files |
|
#+author: Kaushal Modi |
|
|
|
#+setupfile: doc-setupfile.org |
|
|
|
#+macro: imageclick [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/doc/static/images/$1][https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/doc/static/images/$1]] |
|
#+macro: doc [[https://ox-hugo.scripter.co/doc/$1/$2][$3]] |
|
|
|
|
|
* Readme :readme: |
|
:PROPERTIES: |
|
:EXPORT_TITLE: Ox-Hugo: A carefully crafted Org exporter back-end for Hugo |
|
:EXPORT_FILE_NAME: README |
|
:END: |
|
{{{travis}}} {{{melpa}}} {{{GPLv3}}} |
|
|
|
{{{gitter}}} {{{saythanks}}} |
|
|
|
#+include: "./ox-hugo-manual.org::#introduction" :only-contents t |
|
|
|
----- |
|
See the [[https://ox-hugo.scripter.co/doc/examples/][Real World Examples]] section to quickly jump to sites generated |
|
using =ox-hugo= and their Org sources. |
|
** Table of Contents :TOC: |
|
# TOC will be inserted here by `toc-org' package when running |
|
# `ox-hugo-export-gh-doc'. |
|
** Screenshots :noexport_1: |
|
#+include: "./ox-hugo-manual.org::#screenshots_intro" :only-contents t |
|
#+include: "./ox-hugo-manual.org::#screenshots" :only-contents t |
|
** Documentation |
|
=ox-hugo= uses *itself* to generate its documentation! |
|
|
|
https://ox-hugo.scripter.co/ |
|
|
|
You can generate the same too! Simply clone this repo and do =make |
|
doc_md=. |
|
*Make sure you visit the above link to read more on:* |
|
- {{{doc(why-ox-hugo,,Why =ox-hugo=?)}}} |
|
- {{{doc(auto-export-on-saving,,Auto exporting to Markdown each time the Org file is saved)}}} |
|
- {{{doc(org-capture-setup,,Using Org Capture to start a new blog post)}}} |
|
- .. and many more topics and examples |
|
*** Source of the Documentation site |
|
- [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/doc/ox-hugo-manual.org][Org source]] |
|
|
|
The documentation site is published by first using =ox-hugo= to |
|
export from Org to Markdown, and then finally =hugo=. |
|
/So no Markdown files are committed in the =doc/content/= directory./ |
|
#+include: "./ox-hugo-manual.org::#demo" :minlevel 2 |
|
|
|
** Installation |
|
#+include: "./ox-hugo-manual.org::#installation" :only-contents t |
|
** Usage |
|
#+include: "./ox-hugo-manual.org::#usage" :only-contents t |
|
** Changelog :noexport_1: |
|
#+include: "./ox-hugo-manual.org::#changelog" :only-contents t |
|
** Thanks |
|
#+include: "./ox-hugo-manual.org::#thanks" :only-contents t |
|
* Contributing :contributing: |
|
:PROPERTIES: |
|
:EXPORT_TITLE: Contributing Guide |
|
:EXPORT_FILE_NAME: CONTRIBUTING |
|
:END: |
|
#+include: "./ox-hugo-manual.org::#note-to-future-contributors" :only-contents t |
|
** Debug |
|
#+include: "./ox-hugo-manual.org::#debug" :only-contents t |
|
** Test |
|
#+include: "./ox-hugo-manual.org::#test" :only-contents t |
|
* COMMENT Local Variables :ARCHIVE: |
|
# Local Variables: |
|
# eval: (org-hugo-auto-export-mode -1) |
|
# End: |
|
|
|
|