You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Having a lot of helpful scripts is great, but not having a way to share a listing of what you have with others sucks. Clu gives us a listing, but it's not in a particularly shareable way.
Goal: to output the results similar to clu list in such a format that people can easily incorporate into the README of their dotfile repos.
New command
clu export <format>
Initially there will only be one supported format: markdown.
Markdown because that's what almost everyone uses for their Readme.
Since the database contains the source url of each script I think that the format should be as follows (still sorted alphabetically by script name)
| script name | description |
|------------------------------------|-------------------------------------------------|
|[script-name](https://example.com) | description text here which may be notably wide.|
|[next](https://example.com/1) | another description here |
Rather than taking the width from the terminal output it should just be calculated to fit the longest link in the first column and longest description in the second. This will be ridiculously wide, but that's ok, markdown tables are kinda crap, and it's not actually intended to be read in this format.
Output should be send to standard out. Users can always clu export markdown > my.md
The text was updated successfully, but these errors were encountered:
I've added Prettier::Table and used it to display lists and command details (in the v2_staging branch).
Prettier::Table allows you to specify the specific characters used for the surrounding table. I intend to make a .to-markdown method in Prettier::Table to support the generation of GitHub Flavored Markdown tables, which most static blogging tools seem to support.
Having a lot of helpful scripts is great, but not having a way to share a listing of what you have with others sucks. Clu gives us a listing, but it's not in a particularly shareable way.
Goal: to output the results similar to
clu list
in such a format that people can easily incorporate into the README of their dotfile repos.New command
clu export <format>
Initially there will only be one supported format: markdown.
Markdown because that's what almost everyone uses for their Readme.
Since the database contains the source url of each script I think that the format should be as follows (still sorted alphabetically by script name)
Rather than taking the width from the terminal output it should just be calculated to fit the longest link in the first column and longest description in the second. This will be ridiculously wide, but that's ok, markdown tables are kinda crap, and it's not actually intended to be read in this format.
Output should be send to standard out. Users can always
clu export markdown > my.md
The text was updated successfully, but these errors were encountered: