[squeak-dev] Doc! totally psyched
gettimothy
gettimothy at zoho.com
Fri Oct 1 12:23:49 UTC 2021
FYI,
I just realized that the foo.md files are entirely reasonable to edit for people who do not use Emacs or Org.
I learned of a tool , Pandoc, that can covert that .md to .org for me.
So....md may be the choice for sharing/editing documentation
But, I will need to write a PEG and actors to convert from markdown to CustomHelp.
I am going to finish the XPath work and start the SAX work before I tackle that.
I may also have to add a .gitignore on the .org files too to keep things easily in sync for the public.
cheers,
t
---- On Thu, 30 Sep 2021 14:32:39 -0400 gettimothy <gettimothy at zoho.com> wrote ----
Hi Folks.
While neither mature, stable nor feature complete, the DocCustomHelpToOrg and DocOrgToCustomHelp are making documentation easy.
I have a few Emacs Org files that I can import as CustomHelp and also save as markdown via the emacs org mode org-md-export-do-markdown command.
Here is one result of that markdown
https://github.com/gettimothy/Org-DocToCustomHelp/blob/main/DocOrgToCustomHelp.md
Now think about this.
That custom help now exists in three places.
squeak.org/Doc
github.
in my image as a CustomHelp file
and on my filesystem as an org file that is easy to edit.
This has the potential to revolutionize documentation on squeak/pharo
I will be posting another link and continuing the discussion there.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20211001/e986e5e8/attachment.html>
More information about the Squeak-dev
mailing list
|