Closed choldgraf closed 2 years ago
Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:
Argh, I just head from @rowanc1 that this already exists:
https://www.npmjs.com/package/markdown-it-directive
So maybe directives
is not the right name. But still, I feel like a name that is more tied to the functionality we wish to enable, and less tied to docutils
, would help others understand and discover the repository...
This is already being discussed in https://github.com/executablebooks/mystjs/issues/34
Its very much tied to docutils specific implementation of roles and directives
ok I'll close this and go over there
yep no worries 👍
Describe the problem/need and solution
Context This repository draws its name from the
docutils
project in Python, which is a big inspiration for MyST Markdown's syntax. In particular, roles and directives.In addition, it seems that the scope of this repository is explicitly for
docutils-style roles and directives
(from the README).While
docutils
is obviously the inspiration here, and we should give it credit and recognition in our README etc, it is also not a well-known project, especially outside of the Python ecosystem. Moreover, for those who do know it, the namedocutils
may not evoke ideas about well-run and stable packages 😅Proposed action I propose that we rename this repository to
markdown-it-directives
. This would be more descriptive, becausedirective
is a more generally-known term, and it matches more cleanly onto the functionality of this repository. It focuses the repository's name on the feature that it brings, rather than the package that inspired the feature.Note that
roles
is technically a sibling ofdirectives
, not a subset of it, but I think that semantically they are close enough that it wouldn't be confusing for somebody to usemarkdown-it-directives
and expect that in-line roles come along for the ride.If instead we think it is crucial that this package be connected to
docutils
, then I'm fine leaving the name as-is, it's not a huge deal, but I think that if this connection is incidential instead of crucial, we should rename it to make it easier for others to recognize and remember (and to avoid dissuading anybody out there that doesn't want to touch something brandeddocutils
with a 10 foot pole haha).