Greeting! I plan on working <DEV-2718> next. I am ...
# atmos-dev
c
Greeting! I plan on working DEV-2718 next. I am having a little trouble getting the
atmos docs <component>
to render as it seems to require a readme. Any insight that might help?
looks like there was a readme for the
demo-stacks
example. Which one has a table I can use?
I guess I can just use any readme file. I will grab one of another component
@Erik Osterman (Cloud Posse) - I have a few thoughts on this. One of them being that we display the final markup using
less
,
more
, or
vi
. I looked at glow and the tables cannot be viewed easily.
e
Aha, yes, so use the advanced wuickstsrt
Run atmos vendor pull
Then you will have a good readme
Regarding the pager, charmbracelet has go libraries to do this. Glow was an example where they use their libraries to do native paging
We are already using glamour, which is what glow uses under the hood
c
@Erik Osterman (Cloud Posse) - just grabbed one of an EKS module
👍 1
e
The hope is we can bring in the paging stuff as well
Then yes, not sure if glamour has options to improve rendering of tables with line wrapping
The hope is it does
c
@Erik Osterman (Cloud Posse) - Glow’s use of pager for paging was not great. The left and right rendered very oddly. One could no longer really read the table
@Erik Osterman (Cloud Posse) - is there a concern with using an external application to render the output fully?
@Erik Osterman (Cloud Posse) - Is there a reason why you did not want it opened in a browser like the other documentation?
e
Since more and more users are on Windows, we really want to have cross-platform solutions
think of this like a
man
page
so the browser is great, and we might want to support that as well, but there's no canonical location for components that can be accessed from the web.
c
I did some testing and honestly I'm not living how glamour does terminal rows. It also seems to hide the descriptions in the tables by hiding overflow.
On the other hand. I tested a few markdown tools and found it to be the best result for table render
I realized you were trying to create man pages for the components
I'm just not sold on using the readme files from the terminal and expecting the tables to be easy to read
e
It was only if charmbracelet already supports something. I don’t want to spend more than an hour, let’s say doing it. Only going for low hanging fruit
👍 1
Overall charmbracelet does amazing work, but like cloud posse they are small. They have dozens of cool libraries, and they tend to be the best at what they do. Console TUI.
Let’s focus on the parts we can do.