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

Allow other types of readme files #5356

Closed
2 tasks done
s-spindler opened this issue Mar 24, 2022 · 3 comments · Fixed by #5357
Closed
2 tasks done

Allow other types of readme files #5356

s-spindler opened this issue Mar 24, 2022 · 3 comments · Fixed by #5357
Labels
kind/feature Feature requests/implementations

Comments

@s-spindler
Copy link
Contributor

  • I have searched the issues of this repo and believe that this is not a duplicate.
  • I have searched the documentation and believe that my question is not covered.

Feature Request

At the moment only rst and md is supported for README files. Both make sense but the limitation seems arbitrarily restrictive. For example, ascii-doc is used by many organizations as their default markup language.

GitHub itself seems to support a wide variety of markups: https://github.com/github/markup/blob/master/README.md#markups

Since the generated readme file is empty anyway I see no reason why a user shouldn't be allowed to pass the file extension like so:
poetry new --readme adoc

@s-spindler s-spindler added kind/feature Feature requests/implementations status/triage This issue needs to be triaged labels Mar 24, 2022
@eyllanesc
Copy link
Contributor

@s-spindler I think that the limitation is due to pypi that only supports rst and md.

@s-spindler
Copy link
Contributor Author

@eyllanesc You're right, those two are supported. A third option is plaintext: https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/#creating-a-readme-file
So it's not like pypi forbids other markups, it just doesn't render them.

I would still give users the choice. Not everyone uses pypi (e.g. company internal projects that are put in artifactory).

@mkniewallner mkniewallner removed the status/triage This issue needs to be triaged label Jun 11, 2022
Copy link

github-actions bot commented Mar 1, 2024

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/feature Feature requests/implementations
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants