Clojurians Log v2
cljdoc
Is there anything special I need to do to enable table markup in my docstrings? I updated org.clj-commons/pretty but the tables didn't render correctly: https://cljdoc.org/d/org.clj-commons/pretty/2.4.0/api/clj-commons.ansi#compose
I haven't had a chance to set up a local cljdocs image.
The terms:
Characteristic | Values
-- |--
foreground color | `red` or `bright-red` (for each color)
background color | same as foreground color
boldness | `bold`, `faint`, or `plain`
italics | `italic` or `roman`
inverse | `inverse` or `normal`
underline | `underlined` or `not-underlined`
e.g.
i think you need the left and right edges too
| Enabled by default | Version Added | Version Updated |
| ------------------ | ------------- | --------------- |
| true | 0.1 | 0.1 |
I was using https://markdownlivepreview.com/ to compose my docstrings, but it supports a slightly different table syntax. It looked https://github.com/vsch/flexmark-java?tab=readme-ov-file like I could omit the leading/trailing pipes on each line, but perhaps that's an option that cljdoc doesn't enable?
Do we know whether cljdoc/cljdoc docker image works correctly on OS X w/ M1? Seems to get as far as:
WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested
Preparing heap dump dirI does create the heapdumps directory.
Not having a lot of luck with the cljdoc/cljdoc-check-action either.
https://github.com/clj-commons/pretty/actions/runs/8459138409/job/23174878780?pr=115 ... looks like my build doesn't put the pom file where cljdoc expects it. I'll see about that soon.
There must be at least three hyphens in each column of the header row.. That's probably what's screwed up!
Advice for getting cljdoc to build org.clj-commons/pretty snapshot again? I'm basically pushing snapshots to see if it builds correctly.
Joy! With three dashs, even Codox's markdown generator recognizes it as a table.
But I'm still trying to figure out how to get cljdocs to rebuild for my latest 2.5.0-SNAPSHOT
Wow @hlship, you are in a flurry of cljdoc activity today! simple_smile
Yes, it's been nagging me.
For markdown in docstrings cljdoc's intent is to stick to the GitHub flavored markdown variant.
Apologies for the cljdoc check action, it was added but nobody has stepped up to maintain it. So I think it might be a bit stale. I remember you asking about it ages ago... I never got around to giving it some love.
I've never tried the cldoc docker image from macOS on an M1. I do have access to an M1 MacBook, I could try sometime my-tomorrow.
Ok, tomorrow came early! I reproduced your reported issue when running the docker image from an M1 Mac.
Then, I retried but added the --platform linux/amd64 option to my docker run cmd for cljdoc, and it seems to work fine.
Nice; I'll give that a try later.
I threw caution to the wind, pushed my changes, and released pretty 2.5.0 and the table formatting is chef_kiss
You maverick! simple_smile Glad it worked out for you!