emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Excited to Join and Questions
@ 2013-11-24 23:14 Justin Gordon
  2013-11-24 23:31 ` Rasmus
  0 siblings, 1 reply; 2+ messages in thread
From: Justin Gordon @ 2013-11-24 23:14 UTC (permalink / raw)
  To: emacs-orgmode

[-- Attachment #1: Type: text/plain, Size: 2780 bytes --]

Greetings fellow org-mode aficionados! First, a big thanks to all that
contributed to the project. It's one of my all-time favorite tools.

I write to you all as I'm looking for advice on help as I upgrade my blog
publishing system from the older org-mode to the current 8.x architecture.
I wrote a detailed summary of how I did this with 7.8 org-mode here:
http://www.railsonmaui.com/blog/2013/04/27/octopress-setup-with-github-and-org-mode/

That system depended on the old exporter and output HTML, rather than
markdown.

I looked into the org-octopress plugin, but that's not meeting my needs
mostly because the HTML export is not formatting my old org files as I'd
like them to.

So, I'm trying to write an extension of ox-md.el that supports extended
markdown dialects, such as kramdown and rdiscount.

I took the output from ox-md.el, and I have a small list of changes I need
to make for the output. Nicolas as offered me some tips, and suggested I
write to the group so all can benefite.

So here's my grand list of questions:

Strategy
-------------------
What is the right approach for getting dot-org files into Octopress?
Octopress wants Markdown, but Markdown can have embedded HTML:
http://daringfireball.net/projects/markdown/syntax#html
The key consideration is that there must be a blank line before and after
the block-level HTML block (div, table, pre, p, etc.) in Markdown. I'd like
to make it as easy as possible to support liquid templates, as that's a key
part of Octopress. What's the least maintenance in the long run? What's
simplest? I'm guessing that Markdown conversion for the basic syntax with a
fallback to HTML for lesser supported org-elements.

Debugging and Development Tips for Org-Mode?
------------------------------------------------------------------------
1. What are the best links with development advice?
2. What's the best workflow for developing a new exporter? For example,
I've got a small test file that demonstrates the formatting change I'm
trying to implement. I compile my ox-md-ext.el file for edebug mode, and
then I run the code, checking the output and maybe debugging.
3. Related to #2, is there any example of tests that verify the conversion
of input files into output files? Like could I create a few examples of org
code and create some examples of the expected octopress enabled markdown
that should be generated?

Code is where?
-----------------------
Where is the code that formats lines to say 80 chars in the ox-md
conversion? It's breaking up markdown link text with \n.

Thanks in advance for any advice.

Justin Gordon
www.railsonmaui.com | twitter: @railsonmaui<https://twitter.com/railsonmaui>
 | sugarranchmaui.com <http://www.sugarranchmaui.com/> | Sugar Ranch
Blog<https://www.facebook.com/SugarRanch>

[-- Attachment #2: Type: text/html, Size: 4096 bytes --]

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: Excited to Join and Questions
  2013-11-24 23:14 Excited to Join and Questions Justin Gordon
@ 2013-11-24 23:31 ` Rasmus
  0 siblings, 0 replies; 2+ messages in thread
From: Rasmus @ 2013-11-24 23:31 UTC (permalink / raw)
  To: emacs-orgmode

Hi Justin,

Justin Gordon <justin.gordon@gmail.com> writes:

> Debugging and Development Tips for Org-Mode?
> ------------------------------------------------------------------------
> 1. What are the best links with development advice?

The Emacs manual is pretty good.  There's both the Emacs lisp intro
and the Emacs (lisp) manual.  Check info.

> 2. What's the best workflow for developing a new exporter? For example,
> I've got a small test file that demonstrates the formatting change I'm
> trying to implement. I compile my ox-md-ext.el file for edebug mode, and
> then I run the code, checking the output and maybe debugging.

There's now a (unit) testing framework (ERT).  Check testing/README in
org-git.

> 3. Related to #2, is there any example of tests that verify the conversion
> of input files into output files? Like could I create a few examples of org
> code and create some examples of the expected octopress enabled markdown
> that should be generated?

See above.

Hope it helps,
Rasmus

-- 
Summon the Mothership!

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2013-11-24 23:28 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2013-11-24 23:14 Excited to Join and Questions Justin Gordon
2013-11-24 23:31 ` Rasmus

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).