Racket Mode documentation

[Greg Hendershott]

Recently I consolidated and updated Racket Mode documentation.

It is generated in two formats:

- Info: Installed locally. View in Emacs with `C-h i`.

- HTML: View at <https://racket-mode.com/>.


If you're curious how it's prepared:
<https://github.com/greghendershott/racket-mode/tree/master/doc>.

[Sorawee Porncharoenwase]

Hmm. I'm seeing "This site can’t be reached" (DNS_PROBE_FINISHED_NXDOMAIN).

--
You received this message because you are subscribed to the Google Groups "Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to racket-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/racket-users/87sgt48q9r.fsf%40greghendershott.com.
For more options, visit https://groups.google.com/d/optout.

[zeRusski]

this is pretty cool Greg! I, too, had a brief excursion into documenting with Org. It still needs work, but here is an org-source that can be executed to generate the REAME.org (or whatever other format you need) suitable for Github. Some brownie points of this approach: 

- extracts reference documentation from Elisp docstrings (your code does something similar me thinks),

- lets you interleave whatever text or examples you want, 

- collects all examples in the same file and runs them in ERT deftest,

- code that does all that leaves in source blocks in the same Org-file, so basically everything is just one file.

Curiously, this could be a pan-lingua approach, suitable for any proglang, not just Elisp. Maybe with some work, perhaps with some extra work if your language doesn't play nicely with Org Babel or whatever. Org is amazing. I think it should marry Scribble and procreate ))

[zeRusski]

[Sam Tobin-Hochstadt]

It looks like www.racket-mode.com works, but without the www. it doesn't.

Sam

> To view this discussion on the web visit https://groups.google.com/d/msgid/racket-users/CADcuegs5OyyAHu52L%3DDRG8jAvFKTRKJPGW%2B522kX5ESU6RjgjQ%40mail.gmail.com.

[Greg Hendershott]

That also looks cool! Definitely a lot of overlap. Maybe some
differences:

- I'm documenting Emacs major modes (an "app" vs. a lib). So my doc is
less concerned with example code that ought to be tested. More
concerned with stuff like showing default key bindings.

- I wanted the README to get shorter not longer. Instead I wanted users
to get a local/offline Info, and also, produce HTML to host online.


I started out a couple weeks ago, with the vague idea of making a
doc-only Racket package. However the local Info, plus the existing happy
paths to do org->texi->info and org->html, tipped me back to the Emacs
side.

Otherwise and in general I still love using Scribble and scribble/srcdoc
for Racket apps and libs.

[Greg Hendershott]

Sorawee Porncharoenwase <sorawe...@gmail.com> writes:
> Hmm. I'm seeing "This site can’t be reached" (DNS_PROBE_FINISHED_NXDOMAIN).

Instead please try with "www" subdomain:

https://www.racket-mode.com/


Although the zone apex (racket-mode.com) was working for me, yesterday,
probably I don't have it configured correctly to work for all of the
people all of the time. Will consume more coffee and take a look.