Github topic for pandoc

[Teejay128]

Pandoc is used by about 5000 repositories on GitHub, on GitHub, and if a developer curious about the project makes a search for it on GitHub, they are responded with all these repositories

Making a topic for Pandoc on GitHub makes it easier for developers to know more about the project.

I have gone ahead and written a long and short topic, as is the custom of most GitHub topics, if you could review it and make any suggestions

I wasn't sure where to raise the issue, so I chose the most active pandoc repository

[jgm]

Sorry, but what is a "GitHub topic"?

[Teejay128]

My apologies, a GitHub topic basically gives a short introduction about the project. It is used in most popular libraries and frameworks

Writing a topic for pandoc was suggested to me by @tarleb , he said it would be a nice place to start from with contributing

[jgm]

Where are the GitHub topics found? I don't think I've ever run across one -- could you point to an example?

[tarleb]

GitHub topics are those listed in the explore section of GitHub: https://github.com/topics
The repository is https://github.com/github/explore. Each repository can list a number of topics, and clicking on a topic brings the user to the description, if one exists. There is currently no description for pandoc, just a list of projects associated with the topic: https://github.com/topics/pandoc

@Teejay128 is building a technical writing portfolio and reached out for tips. Providing a GitHub topic seemed like a nice, visible project that would also demonstrate technical skills and familiarity with git.

[Teejay128]

Thanks a lot @tarleb

@jgm the easiest way to know what a topic is to search a particular project or library in the GitHub search bar. You get a short description of the project…

but if you search for pandoc, you just get a list of the repositories that make use of pandoc

[tarleb]

Closing for now, but please feel free to give it a go.