* Writing your book with orgmode and publishing it on Leanpub @ 2014-02-23 19:24 Juan Reyero 2014-02-24 7:39 ` Waldemar Quevedo 0 siblings, 1 reply; 6+ messages in thread From: Juan Reyero @ 2014-02-23 19:24 UTC (permalink / raw) To: org-mode Mailing List Greetings, I've solved a couple of bugs in the Leanpub[1] markdown exporter[2] (cross-links within the book using ids were not working, and footnotes containing a colon neither). As far as I can tell using Orgmode and Leanpub to publish books is now quite feasible, and produces rather nice results. I have also published the sources for my book, The Hacker Ways[3], at https://github.com/juanre/hacker-ways It is rather annoying that github understands the org syntax but not quite, so the sources appear almost but not quite right. Clone and open in Emacs to see what's going on. Best regards, jm -- http://greaterskies.com http://juanreyero.com [1] Leanpub.com is a very nice self-publishing platform. I am not associated with them, and they are not responsible for my code. [2] http://juanreyero.com/open/ox-leanpub/ [3] https://leanpub.com/hackerways/ ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Writing your book with orgmode and publishing it on Leanpub 2014-02-23 19:24 Writing your book with orgmode and publishing it on Leanpub Juan Reyero @ 2014-02-24 7:39 ` Waldemar Quevedo 2014-02-24 8:33 ` Juan Reyero 2014-02-24 9:23 ` Sebastien Vauban 0 siblings, 2 replies; 6+ messages in thread From: Waldemar Quevedo @ 2014-02-24 7:39 UTC (permalink / raw) To: Juan Reyero; +Cc: org-mode Mailing List [-- Attachment #1: Type: text/plain, Size: 1634 bytes --] Hi, > It is rather annoying that github understands the org syntax but not quite, so the sources appear almost but not quite right. I maintain the parser that is being by Github => https://github.com/wallyqs/org-ruby If you let me now the issues I can try to fix them, (or PRs are also welcome).... I also noticed that you are using Jekyll with Org mode, so in case you are not a fan a adding YAML to your Org mode files I have this example where you can use `#+layout:` instead of YAML. https://github.com/wallyqs/yet-another-jekyll-org-template https://github.com/eggcaker/jekyll-org/blob/master/convert.rb#L30 Regards, - Waldemar On Mon, Feb 24, 2014 at 4:24 AM, Juan Reyero <joanmg@gmail.com> wrote: > Greetings, > > I've solved a couple of bugs in the Leanpub[1] markdown exporter[2] > (cross-links within the book using ids were not working, and footnotes > containing a colon neither). As far as I can tell using Orgmode and > Leanpub to publish books is now quite feasible, and produces rather > nice results. > > I have also published the sources for my book, The Hacker Ways[3], at > > https://github.com/juanre/hacker-ways > > It is rather annoying that github understands the org syntax but not > quite, so the sources appear almost but not quite right. Clone and > open in Emacs to see what's going on. > > Best regards, > > jm > -- > http://greaterskies.com > http://juanreyero.com > > [1] Leanpub.com is a very nice self-publishing platform. I am not > associated with them, and they are not responsible for my code. > > [2] http://juanreyero.com/open/ox-leanpub/ > > [3] https://leanpub.com/hackerways/ > > [-- Attachment #2: Type: text/html, Size: 3345 bytes --] ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Writing your book with orgmode and publishing it on Leanpub 2014-02-24 7:39 ` Waldemar Quevedo @ 2014-02-24 8:33 ` Juan Reyero 2014-02-24 12:26 ` Waldemar Quevedo 2014-02-24 9:23 ` Sebastien Vauban 1 sibling, 1 reply; 6+ messages in thread From: Juan Reyero @ 2014-02-24 8:33 UTC (permalink / raw) To: Waldemar Quevedo; +Cc: org-mode Mailing List On Mon, Feb 24, 2014 at 8:39 AM, Waldemar Quevedo <waldemar.quevedo@gmail.com> wrote: >> It is rather annoying that github understands the org syntax but not >> quite, so the sources appear almost but not quite right. > I maintain the parser that is being by Github => > https://github.com/wallyqs/org-ruby > If you let me now the issues I can try to fix them, (or PRs are also > welcome).... Sorry I sounded dismissive. You are doing an awesome job, it's amazing how much it did get right. My problem is that I am trying to share my sources as code, not as documentation. I would like my .org files to be treated as you would treat Python code, shown as they are and syntax-highlighted. If you parse them you will inevitably miss the context I am relying upon to render them properly (like when you ---rightly--- assume that html should be left standing, but what I wrote expects a jekyll post-process). People visiting the repository will most likely be interested in what I actually wrote, not in its rendering as a document. Close to what you get when you select Raw, but syntax-highlighted. This is what I want the repository for; the document is somewhere else. That said, the one place where the translation fails is when the source code of babel snippets should not be exported. Again, probably due to the tension between the need to show the file's content and the desire to render it as a document. > I have this example > where you can use `#+layout:` instead of YAML. > https://github.com/wallyqs/yet-another-jekyll-org-template > https://github.com/eggcaker/jekyll-org/blob/master/convert.rb#L30 Thank you for the pointer. Best, jm > On Mon, Feb 24, 2014 at 4:24 AM, Juan Reyero <joanmg@gmail.com> wrote: >> >> Greetings, >> >> I've solved a couple of bugs in the Leanpub[1] markdown exporter[2] >> (cross-links within the book using ids were not working, and footnotes >> containing a colon neither). As far as I can tell using Orgmode and >> Leanpub to publish books is now quite feasible, and produces rather >> nice results. >> >> I have also published the sources for my book, The Hacker Ways[3], at >> >> https://github.com/juanre/hacker-ways >> >> It is rather annoying that github understands the org syntax but not >> quite, so the sources appear almost but not quite right. Clone and >> open in Emacs to see what's going on. >> >> Best regards, >> >> jm >> -- >> http://greaterskies.com >> http://juanreyero.com >> >> [1] Leanpub.com is a very nice self-publishing platform. I am not >> associated with them, and they are not responsible for my code. >> >> [2] http://juanreyero.com/open/ox-leanpub/ >> >> [3] https://leanpub.com/hackerways/ >> > -- http://greaterskies.com http://juanreyero.com ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Writing your book with orgmode and publishing it on Leanpub 2014-02-24 8:33 ` Juan Reyero @ 2014-02-24 12:26 ` Waldemar Quevedo 0 siblings, 0 replies; 6+ messages in thread From: Waldemar Quevedo @ 2014-02-24 12:26 UTC (permalink / raw) To: Juan Reyero; +Cc: org-mode Mailing List [-- Attachment #1: Type: text/plain, Size: 4054 bytes --] > Sorry I sounded dismissive. You are doing an awesome job, it's amazing how much it did get right. No problem at all :) > My problem is that I am trying to share my sources as code, not as > documentation. I would like my .org files to be treated as you would > treat Python code, shown as they are and syntax-highlighted. I've been trying to have syntax highlighting available for documents rendered in Github for a while now. Possibly when this pull request is accepted thinks would be highlighted: https://github.com/github/markup/pull/254 > That said, the one place where the translation fails is when the > source code of babel snippets should not be exported. Again, probably > due to the tension between the need to show the file's content and the > desire to render it as a document. I think this might be because :exports none|both|source is currently not implemented for source code blocks, I will try to get this included in the next version of the gem. Thanks for the feedback, and please if you find another issue let me know by creating an issue :) Regards, - Wally On Mon, Feb 24, 2014 at 5:33 PM, Juan Reyero <joanmg@gmail.com> wrote: > On Mon, Feb 24, 2014 at 8:39 AM, Waldemar Quevedo > <waldemar.quevedo@gmail.com> wrote: > >> It is rather annoying that github understands the org syntax but not > >> quite, so the sources appear almost but not quite right. > > I maintain the parser that is being by Github => > > https://github.com/wallyqs/org-ruby > > If you let me now the issues I can try to fix them, (or PRs are also > > welcome).... > > Sorry I sounded dismissive. You are doing an awesome job, it's > amazing how much it did get right. > > My problem is that I am trying to share my sources as code, not as > documentation. I would like my .org files to be treated as you would > treat Python code, shown as they are and syntax-highlighted. If you > parse them you will inevitably miss the context I am relying upon to > render them properly (like when you ---rightly--- assume that html > should be left standing, but what I wrote expects a jekyll > post-process). > > People visiting the repository will most likely be interested in what > I actually wrote, not in its rendering as a document. Close to what > you get when you select Raw, but syntax-highlighted. This is what I > want the repository for; the document is somewhere else. > > That said, the one place where the translation fails is when the > source code of babel snippets should not be exported. Again, probably > due to the tension between the need to show the file's content and the > desire to render it as a document. > > > I have this example > > where you can use `#+layout:` instead of YAML. > > https://github.com/wallyqs/yet-another-jekyll-org-template > > https://github.com/eggcaker/jekyll-org/blob/master/convert.rb#L30 > > Thank you for the pointer. > > Best, > > jm > > > On Mon, Feb 24, 2014 at 4:24 AM, Juan Reyero <joanmg@gmail.com> wrote: > >> > >> Greetings, > >> > >> I've solved a couple of bugs in the Leanpub[1] markdown exporter[2] > >> (cross-links within the book using ids were not working, and footnotes > >> containing a colon neither). As far as I can tell using Orgmode and > >> Leanpub to publish books is now quite feasible, and produces rather > >> nice results. > >> > >> I have also published the sources for my book, The Hacker Ways[3], at > >> > >> https://github.com/juanre/hacker-ways > >> > >> It is rather annoying that github understands the org syntax but not > >> quite, so the sources appear almost but not quite right. Clone and > >> open in Emacs to see what's going on. > >> > >> Best regards, > >> > >> jm > >> -- > >> http://greaterskies.com > >> http://juanreyero.com > >> > >> [1] Leanpub.com is a very nice self-publishing platform. I am not > >> associated with them, and they are not responsible for my code. > >> > >> [2] http://juanreyero.com/open/ox-leanpub/ > >> > >> [3] https://leanpub.com/hackerways/ > >> > > > > > > -- > http://greaterskies.com > http://juanreyero.com > [-- Attachment #2: Type: text/html, Size: 8042 bytes --] ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Writing your book with orgmode and publishing it on Leanpub 2014-02-24 7:39 ` Waldemar Quevedo 2014-02-24 8:33 ` Juan Reyero @ 2014-02-24 9:23 ` Sebastien Vauban 2014-02-24 12:08 ` Waldemar Quevedo 1 sibling, 1 reply; 6+ messages in thread From: Sebastien Vauban @ 2014-02-24 9:23 UTC (permalink / raw) To: emacs-orgmode-mXXj517/zsQ Hello Waldemar, Waldemar Quevedo wrote: >> It is rather annoying that github understands the org syntax but not >> quite, so the sources appear almost but not quite right. > > I maintain the parser that is being by Github => > https://github.com/wallyqs/org-ruby > If you let me now the issues I can try to fix them, (or PRs are also > welcome).... For me, an annoying problem is that the Org #+TITLE is treated as a simple text, and not outputted as an headline. So, if we want an headline on GitHub, we need to create a unique level-1 heading, which will be shown as the most important section, hence the "title". Then, under that, we can have many level-2 sections. That feature makes it impossible to get the same design for Org documents both as PDF, HTML or GitHub presentation page. Best regards, Seb -- Sebastien Vauban ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Writing your book with orgmode and publishing it on Leanpub 2014-02-24 9:23 ` Sebastien Vauban @ 2014-02-24 12:08 ` Waldemar Quevedo 0 siblings, 0 replies; 6+ messages in thread From: Waldemar Quevedo @ 2014-02-24 12:08 UTC (permalink / raw) To: Sebastien Vauban; +Cc: emacs-orgmode [-- Attachment #1: Type: text/plain, Size: 1523 bytes --] Sebastien, > For me, an annoying problem is that the Org #+TITLE is treated as > a simple text, and not outputted as an headline. > So, if we want an headline on GitHub, we need to create a unique level-1 > heading, which will be shown as the most important section, hence the > "title". Then, under that, we can have many level-2 sections. Ok, I will revisit this part of the output from the parser and change it in the next release so that Github can also pick it up (issue here: https://github.com/wallyqs/org-ruby/issues/3) Thanks, - Wally On Mon, Feb 24, 2014 at 6:23 PM, Sebastien Vauban <sva-news@mygooglest.com>wrote: > Hello Waldemar, > > Waldemar Quevedo wrote: > >> It is rather annoying that github understands the org syntax but not > >> quite, so the sources appear almost but not quite right. > > > > I maintain the parser that is being by Github => > > https://github.com/wallyqs/org-ruby > > If you let me now the issues I can try to fix them, (or PRs are also > > welcome).... > > For me, an annoying problem is that the Org #+TITLE is treated as > a simple text, and not outputted as an headline. > > So, if we want an headline on GitHub, we need to create a unique level-1 > heading, which will be shown as the most important section, hence the > "title". Then, under that, we can have many level-2 sections. > > That feature makes it impossible to get the same design for Org > documents both as PDF, HTML or GitHub presentation page. > > Best regards, > Seb > > -- > Sebastien Vauban > > > [-- Attachment #2: Type: text/html, Size: 3401 bytes --] ^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2014-02-24 12:27 UTC | newest] Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2014-02-23 19:24 Writing your book with orgmode and publishing it on Leanpub Juan Reyero 2014-02-24 7:39 ` Waldemar Quevedo 2014-02-24 8:33 ` Juan Reyero 2014-02-24 12:26 ` Waldemar Quevedo 2014-02-24 9:23 ` Sebastien Vauban 2014-02-24 12:08 ` Waldemar Quevedo
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).