Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate the readme markdown table #24

Open
moul opened this issue Jul 28, 2023 · 3 comments
Open

Automate the readme markdown table #24

moul opened this issue Jul 28, 2023 · 3 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@moul
Copy link
Member

moul commented Jul 28, 2023

The README is outdated. By incorporating metadata in our presentations via frontmatter in the README.md or a metadata.yml file, we can keep it accurate and consistent.

@moul moul added good first issue Good for newcomers help wanted Extra attention is needed labels Jul 28, 2023
@moul
Copy link
Member Author

moul commented Aug 1, 2023

Check out this handy tool I created: mdtable.

Next steps:

  1. Implement metadata files.
  2. Create a script to merge metadata into a CSV file.
  3. Utilize mdtable.
  4. Embed the generated markdown into the readme, using embedmd.

@leohhhn
Copy link
Contributor

leohhhn commented Sep 30, 2024

Done in #60

@moul
Copy link
Member Author

moul commented Oct 2, 2024

Awesome, it looks nice!

Improvement suggestions:

  • Don't limit to 15; show everything.
  • Limit the columns size and add automatic ellipsis.
  • Add a new duration column that can display "<30m" instead of the accurate duration.
  • Add a new tags column to keep the list short and useful, such as "purpose" tags.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants