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

Automatic TOC generation #4

Open
kubouch opened this issue Jan 23, 2021 · 3 comments
Open

Automatic TOC generation #4

kubouch opened this issue Jan 23, 2021 · 3 comments
Labels
help wanted Extra attention is needed

Comments

@kubouch
Copy link
Contributor

kubouch commented Jan 23, 2021

Just to log the discussion from #1 here.

Would be good to have a) a table of contents listing all scripts, b) some system to generate it automatically so we don't have to update it manually.

@fdncred fdncred added the help wanted Extra attention is needed label Jan 24, 2021
@fdncred
Copy link
Collaborator

fdncred commented Jan 24, 2021

We're looking for volunteers to write such a script that anyone can run locally prior to submitting a PR for script additions or changes.

@ibraheemdev
Copy link

GitHub cannot do this automatically (isaacs/github#215) so we can use a tool like github-markdown-toc.

@fdncred
Copy link
Collaborator

fdncred commented Feb 1, 2021

I wrote a script called make_readme_table.nu and put it in this repo. It doesn't do it "automatically" but it's a start if someone wants to take over and play with it.

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

Successfully merging a pull request may close this issue.

3 participants