Skip to content
This repository has been archived by the owner on Apr 21, 2022. It is now read-only.

Code section comments with # get their own table of contents entry in the readme #310

Open
PhilLavoie opened this issue Feb 10, 2021 · 1 comment

Comments

@PhilLavoie
Copy link

For example:

# Stuff you need to do

```bash
# Run this command if you want, but it's a good idea.
echo "hello"
```

oclif-dev readme will generate a TOC that contains this:

* [Stuff you need to do](#stuff-you-need-to-do)
* [Run this command if you want, but it's a good idea](#run-this-command-if-you-want-but-its-a-good-idea)
@PhilLavoie
Copy link
Author

Tested wth @oclif/dev-cli@1.26.0

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant