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.

Sign up for GitHub

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

Jump to bottom

Automate the readme markdown table #24

Open
moul opened this issue Jul 28, 2023 · 1 comment
Open

Automate the readme markdown table #24

moul opened this issue Jul 28, 2023 · 1 comment
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.

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

No branches or pull requests
1 participant
@moul