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

Using headings instead of bold text inside index.md #238

Closed
markusmo3 opened this issue Sep 4, 2015 · 5 comments
Closed

Using headings instead of bold text inside index.md #238

markusmo3 opened this issue Sep 4, 2015 · 5 comments

Comments

@markusmo3
Copy link
Contributor

Currently we are using bold text as a heading of a chapter (Intent, Applicability, Real world examples, ...)
Example: **Intent:**
Correct me if i'm wrong but i think this is a relic from the time before the great split. Nowadays we wont clutter the readme with too much headings.

I think turning those into Headings would improve the readability, the overview and, if i re-implement the TOC in the sidebar, even the navigation.

If we do that we should use at least the second level heading, as the first level is the name of the pattern.

@markusmo3
Copy link
Contributor Author

@iluwatar, @npathai any thoughts on this ?
If this feature is wanted i could try and script something up.

@iluwatar
Copy link
Owner

Good that you brought this up. When I look at it the bold text seems rather small for the purpose. 👍 for the bigger headings.

@npathai
Copy link
Contributor

npathai commented Sep 11, 2015

👍 from me too. Go for it.

fluxw42 added a commit to fluxw42/java-design-patterns that referenced this issue Jan 3, 2016
markusmo3 pushed a commit that referenced this issue Jan 4, 2016
Use headings instead of bold text in index.md #238

Script used to do it: https://gist.github.com/fluxw42/464820d08e3b567fda48
@markusmo3
Copy link
Contributor Author

With the PR merged and the wiki edited this issue is fixed.

@iluwatar
Copy link
Owner

iluwatar commented Jan 4, 2016

👍 Looks great

pratigya0 pushed a commit to pratigya0/java-design-patterns that referenced this issue Aug 3, 2023
* style: icons size changed, img without white bg

* Update README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants