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

Show the descriptions of categories #69

Open
2 tasks
eine opened this issue Jan 21, 2021 · 3 comments
Open
2 tasks

Show the descriptions of categories #69

eine opened this issue Jan 21, 2021 · 3 comments
Labels
good first issue Good for newcomers theme

Comments

@eine
Copy link
Contributor

eine commented Jan 21, 2021

As discussed in #1, the meaning and differences between categories might no be clear.

  • Support multiline descriptions of the categories in config.yml.
  • Show the descriptions of the categories in the site/theme.
@eine eine added theme good first issue Good for newcomers labels Jan 21, 2021
@rodrigomelo9
Copy link
Contributor

Hi. I checked and the description is showed (check Frameworks here https://hdl.github.io/awesome/categories/). Probably, could be better to change the style. Or you are talking about a special page for that?

And regarding multiline descriptions:

  • First, I hope no to long descriptions :-D
  • Second, is not enough to employ "" or |? Did you detect a problem?

Let me know to implement what needed ;-)

@eine
Copy link
Contributor Author

eine commented Jan 23, 2021

The motivation for this issue was Patrick's clarification about the difference between a collection and a library. I then found that some very brief description is shown in the page you said. I think that might not be enough.

I don't know whether we should add slightly longer descriptions there, or we should have an About page where categories are better explained. It's up to you!

There should be no problem for using YAML syntax for multilines. We avoided it at first because we wanted to keep descriptions really short. But we do need to make some clarifications...

@eine
Copy link
Contributor Author

eine commented Jan 23, 2021

Maybe a short description of the category can be shown in https://hdl.github.io/awesome/categories/, and then a longer one can be shown in the list view of each category. For instance: https://hdl.github.io/awesome/categories/frameworks/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers theme
Projects
None yet
Development

No branches or pull requests

2 participants