search

thlorenz / doctoc

📜 Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites.
https://www.npmjs.com/package/doctoc
MIT License
4.23k stars 480 forks source link

Share instructions for usage with unofficial doctoc Docker container `docker-doctoc`. #254

Closed tapyu closed 4 months ago

tapyu commented 9 months ago

I just added a workflow example which can help people to use doctoc with Docker containers.

tapyu commented 9 months ago

I accidentally deleted the forked repo. That is why I am opening this PR once again :)

AndrewSouthpaw commented 4 months ago

Thanks for sharing! Since this is an unofficial container, I don't think it warrants adding to the README. However we can leave your PR here and others can refer to it later through searching.

You might consider editing your PR description to refer to some of the keywords so people might stumble across it more easily. 😄

tapyu commented 4 months ago

@AndrewSouthpaw , so... That is a problem for me :grimacing:

In order to better organize my repositories, forked repos targeting PRs are prefixed with to-delete and are deleted once they are merged or closed. Otherwise, I would have several idle PR-aimed forked repositories. Having an opened PR makes no sense for me.

Moreover, if I simply delete the forked repo, this PR will be lost and you won't be able to refer to these modifications. That being said, I suggest you to decide whether accept or reject this PR because sooner or later I will delete my forked repo, and when I do so, this PR will be automatically lost.

Personally, I see no reasons to avoid something that is "unofficial". What is the matter? Unofficial things are awesome. As long as it is working (and it is indeed working), it should be in your README.md file to help anyone who wants to use doctoc. If you disagree, no problems, but unfortunately, due to my approach, this PR will be lost and you won't be able to refer to these modifications.

AndrewSouthpaw commented 4 months ago

Hi there! Thanks for raising the concerns. I was pretty sure the diff sticks around after the forked repo is deleted, and that does appear to be the case. So it seems fine to leave as-is; people will have access to the documentation if they search for it.