pml-companion icon indicating copy to clipboard operation
pml-companion copied to clipboard

Enhance Repository and Org Visibility on GitHub

Open tajmone opened this issue 4 years ago • 1 comments

To enhance the repository visibility:

Repository Details

Edit About box setting (repository details):

  • [x] Website field, add: https://www.pml-lang.dev
  • [x] Topics field, add: pml practical-markup-language html-converter (etc.)
  • [x] Include in the homepage field, remove "Package" (if not needed).

GitHub topics are a powerful feature, they don't just simplifying find repositories on GitHub: by adding PML keywords to the topics you're actually promoting PML's visibility on GitHub, and once a keyword reaches a certain numbers of repository that are using it you automatically obtain visibility on various GitHub services and sub-pages.

Media Preview Card

  • [ ] Add repository media preview.

In Settings » Options: "Social preview" you can add a social media preview card for the PML repository, which will be showed whenever the repository is linked in websites, blogs and forums that support media cards. You'll also find a link to a graphic template there, to build your card with.

You can use the SocialSharePreview.com or Twitter Card Validator services to check how your card looks like. E.g., here's the link to the media preview card of Sublime-PML; and here's a screenshot from Twitter:

Sublime-PML-social-card-preview

If you need any help with the graphics, just buzz me via PM. I work a lot of graphics.

Add pml-lang Profile README

To enhance the landing page of the pml-lang GitHub profile, add a profile README:

  • [ ] Create new repository: pml-lang/pml-lang
    • [ ] Add README.md (or .asciidoc, etc.) with a brief presentation of PML (not 100% sure, but I think you can include images in the repository too).

Needless to say, the same tips apply to any other repository and to the pxml-lang as well.

tajmone avatar May 01 '21 03:05 tajmone

Great suggestions! Thank you.

pml-lang avatar May 03 '21 07:05 pml-lang