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 extensions to specify a different file than README to be displayed on the marketplace #210

Closed
joaomoreno opened this issue Nov 6, 2017 · 6 comments
Labels
feature-request Request for new features or functionality help wanted Issues identified as good community contribution opportunities out-of-scope

Comments

@joaomoreno
Copy link
Member

@davidanthoff says:

It would be great if I could specify the path to some alternative markdown file in the package.json for inclusion in the marketplace instead of the README.md content. Essentially, if that setting is there in package.json, don't include the content from README.md on the marketplace, but instead use the content of the file specified.

The reason is that I want the README.md to contain information that is really more meant for the devs of the extension: status badges for builds, instructions how to dev on the extension etc. But for the users of the extension I want different content to be shown in the marketplace.

@joaomoreno
Copy link
Member Author

Want to attempt a PR? Should be straightforward enough.

@davidanthoff
Copy link

I'm afraid I'm maxed out on the open-source projects I can contribute, so don't expect a PR from my anytime soon :)

@shanalikhan
Copy link

Need this for Code Settings Sync also

@raix
Copy link
Contributor

raix commented Dec 12, 2017

I might do a pr tomorrow unless others get there first

@joaomoreno joaomoreno added help wanted Issues identified as good community contribution opportunities feature-request Request for new features or functionality labels Sep 20, 2018
@joaomoreno joaomoreno removed this from the Backlog milestone Oct 11, 2019
@meajinkya
Copy link

@raix any update here? :)

@raix
Copy link
Contributor

raix commented Oct 20, 2020

@meajinkya unfortunately no - I'm likely not going to have time for it 😞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for new features or functionality help wanted Issues identified as good community contribution opportunities out-of-scope
Projects
None yet
Development

No branches or pull requests

5 participants