Is it somewhere on the roadmap to have basic org-mode syntax support for files (including readme file)?
Most, if not all the files I work on in Emacs are documentation files written in org mode and it would be nice not to have to convert them to md to have basic display of their contents on SH.
--
Jean-Christophe Helary @brandelune
https://mac4translators.blogspot.comhttps://sr.ht/~brandelune/omegat-as-a-book/
> Is it somewhere on the roadmap to have basic org-mode syntax support for files (including readme> files)
It has been discussed a few times before and there are no plans[1]. You are able to use an
arbitrary HTML snippet to render your readme[2] tho.
[1]https://lists.sr.ht/~sircmpwn/sr.ht-discuss/%3Cfe7aa296-9c90-463d-b4e6-50eeb7e57428%40localhost%3E#%3CC15MWAA4L1V4.37TIKIXPHV02J@homura%3E
[2]https://man.sr.ht/git.sr.ht/#setting-a-custom-readme
> On Oct 2, 2021, at 14:04, noah@ntgg.io wrote:> >> Is it somewhere on the roadmap to have basic org-mode syntax support for files (including readme>> files)> > It has been discussed a few times before and there are no plans[1].
Ok. It makes sense. Thank you for the pointer.
> You are able to use an> arbitrary HTML snippet to render your readme[2] tho.
I eventually just remembered that HTML was MD compatible... So exporting to HTML with org-export-dispatch, changing the extension to .md and making a few edits actually works. Quite an ugly hack but it is good enough.
--
Jean-Christophe Helary @brandelune
https://mac4translators.blogspot.comhttps://sr.ht/~brandelune/omegat-as-a-book/
On Sat Oct 2, 2021 at 7:32 AM CEST, Jean-Christophe Helary wrote:
>>> > On Oct 2, 2021, at 14:04, noah@ntgg.io wrote:> > > >> Is it somewhere on the roadmap to have basic org-mode syntax support for files (including readme> >> files)> > > > It has been discussed a few times before and there are no plans[1].>> Ok. It makes sense. Thank you for the pointer.>> > You are able to use an> > arbitrary HTML snippet to render your readme[2] tho.>> I eventually just remembered that HTML was MD compatible... So exporting> to HTML with org-export-dispatch, changing the extension to .md and> making a few edits actually works. Quite an ugly hack but it is good> enough.
Follow the link Noah provided. It's to documentation of a sr.ht feature
in which you can upload HTML to an API endpoint to use as your readme
instead of using a file from your repo. Then you can configure a
builds.sr.ht job to render from whatever (e.g. org mode) into HTML and
then send it to the API.
> On Oct 2, 2021, at 14:59, Drew DeVault <sir@cmpwn.com> wrote:> > Follow the link Noah provided.
I did.
> It's to documentation of a sr.ht feature> in which you can upload HTML to an API endpoint to use as your readme> instead of using a file from your repo. Then you can configure a> builds.sr.ht job to render from whatever (e.g. org mode) into HTML and> then send it to the API.
I have no idea what an API is, how I can make use of it, and how graphql
could be useful for my daily tasks as a writer. Right now all that is
more than a bit overwhelming, so I'll just stick to exporting org to md
on my side.
But it's definitely on my todo list to make sense of all that. Problem is,
I have no idea *where* to start.
--
Jean-Christophe Helary @brandelune
https://mac4translators.blogspot.comhttps://sr.ht/~brandelune/omegat-as-a-book/
> On Oct 2, 2021, at 14:59, Drew DeVault <sir@cmpwn.com> wrote:> > On Sat Oct 2, 2021 at 7:32 AM CEST, Jean-Christophe Helary wrote:>> >> >>> On Oct 2, 2021, at 14:04, noah@ntgg.io wrote:>>> >>>> Is it somewhere on the roadmap to have basic org-mode syntax support for files (including readme>>>> files)>>> >>> It has been discussed a few times before and there are no plans[1].>> >> Ok. It makes sense. Thank you for the pointer.>> >>> You are able to use an>>> arbitrary HTML snippet to render your readme[2] tho.>> >> I eventually just remembered that HTML was MD compatible... So exporting>> to HTML with org-export-dispatch, changing the extension to .md and>> making a few edits actually works. Quite an ugly hack but it is good>> enough.> > Follow the link Noah provided. It's to documentation of a sr.ht feature> in which you can upload HTML to an API endpoint to use as your readme> instead of using a file from your repo. Then you can configure a> builds.sr.ht job to render from whatever (e.g. org mode) into HTML and> then send it to the API.
Also, I just discovered that org had an export library that was not loaded
by default. Problem solved! Apologies for the noise.
--
Jean-Christophe Helary @brandelune
https://mac4translators.blogspot.comhttps://sr.ht/~brandelune/omegat-as-a-book/
>I have no idea what an API is
It's an initialism which stands for Application Programming Interface. It's a way for a program you write to hook into a different program or service. Usually this takes the form of a web service which has specifically formatted URL's (called endpoints) that allow you to perform specific actions. In this case, it would allow you to upload semi-arbitrary HTML to load as your project's README rather than use a file from the repository for that purpose.
> and how graphql could be useful for my daily tasks as a writer.
It probably wouldn't be. Graphql is a technology which is designed to make writing and using API's easier. If you don't frequently use API's, it'll be of limited value to you.
If you're still curious, the main documentation for the technology itself is here:
https://graphql.org
> On Oct 2, 2021, at 22:39, Chris McGowan <cmcgowan9990@gmail.com> wrote:> >> I have no idea what an API is> > It's an initialism which stands for Application Programming Interface. It's a way for a program you write to hook into a different program or service. Usually this takes the form of a web service which has specifically formatted URL's (called endpoints) that allow you to perform specific actions. In this case, it would allow you to upload semi-arbitrary HTML to load as your project's README rather than use a file from the repository for that purpose.> >> and how graphql could be useful for my daily tasks as a writer.> > It probably wouldn't be. Graphql is a technology which is designed to make writing and using API's easier. If you don't frequently use API's, it'll be of limited value to you.
Thank you Chris for the explanations.
I write a lot of org data, I have the choice between exporting them to md and committing them to the sr.ht wiki or repository readme, or going the HTML+graphql route.
> If you're still curious, the main documentation for the technology itself is here:> https://graphql.orghttps://graphql.org/learn/
I'm always curious and I do write a bit of code and a fair bit of html/css, but there was literally *nothing* there that made any sense to me.
--
Jean-Christophe Helary @brandelune
https://mac4translators.blogspot.comhttps://sr.ht/~brandelune/omegat-as-a-book/