janet-lang / janet-lang.org

Website for janet
https://janet-lang.org
MIT License
90 stars 59 forks source link

Document spork/utf8. #206

Closed amano-kenji closed 3 months ago

amano-kenji commented 7 months ago

It's available, but it's not documented on janet website.

Plus, janet REPL doesn't provide autocompletion for janet modules...

It took some time to discover this module...

sogaiu commented 7 months ago

I didn't find a page for spork/utf8 either.

Snooping around, it looks like there are a couple relevant-looking things that are from spork/utf8 though:

But it seems there may not be a page specifically for spork/utf8 (as compared with say, one for spork/argparse).

Perhaps an appropriate file can get added to this directory and when the site is rebuilt things will work out?

Based on what I see for crc, may be something like the following in a file named utf8.mdz?

(import ../gen-docs :as gen-docs)
(import spork/utf8 :export true)
(setdyn :source-linker (partial gen-docs/github-source-linker "janet-lang/spork" gen-docs/spork-version))

{:title "UTF8"
 :nav-title "utf8"
 :template "docpage.html"}
---

## Index

@gen-docs/gen-prefix-current[utf8/]

Don't really know how this works (^^;

sogaiu commented 7 months ago

Ok, I tried out the guessed steps above and it seems to work.

Created a related PR #211.

amano-kenji commented 7 months ago

:feet:

sogaiu commented 3 months ago

It looks like #211 has been merged, so may be this can be closed now.