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

Center title and links in README #505

Merged
merged 4 commits into from
Sep 7, 2018

Conversation

salmanulfarzy
Copy link
Member

@salmanulfarzy salmanulfarzy commented Aug 28, 2018

This is intended to improve accessibility of documentation and better UI. But, this comes at cost of including HTML directly inside markdown due to limitations of markdown syntax and affects readability of README.

Included Changes

  • Title, tagline and badges centered
  • Quick link to website, install instructions, features, options and API. Centered and separated with vertical bar (|)
  • Moved preview to top, So user don't have to scroll the lengthy features list to see how beautiful the prompt looks
  • Link to contributors pages
  • Link to preview setup just below preview (It have been asked so.. many times)

Direct link to branch page: salmanulfarzy/spaceship-prompt@center-doc


Before

master doc

After

doc UI changes

@salmanulfarzy salmanulfarzy added improvement A PR that make small changes for improving UX, performance, readability, etc docs Issue or PR is related to documentation. labels Aug 28, 2018
@salmanulfarzy salmanulfarzy self-assigned this Aug 28, 2018
README.md Outdated
> A [Zsh][zsh-url] prompt for Astronauts.
<div align="center">
<h4>
<a href="https://denysdovhan.com/spaceship-prompt/">Website |</a>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest removing the | dividers from the <a> tags. The underline behavior is unexpected with the dividers within the tag.

image

Copy link
Member

@denysdovhan denysdovhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @salmanulfarzy! Looks prettier ❤️

@salmanulfarzy salmanulfarzy merged commit 26c671b into spaceship-prompt:master Sep 7, 2018
salmanulfarzy added a commit that referenced this pull request Sep 7, 2018
Center title and links in README
@salmanulfarzy
Copy link
Member Author

Could you also check #396 ? Our documentation on website haven't updated in the last several months. Anything that I could to get that merged ?

@salmanulfarzy salmanulfarzy deleted the center-doc branch September 29, 2018 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issue or PR is related to documentation. improvement A PR that make small changes for improving UX, performance, readability, etc
Development

Successfully merging this pull request may close these issues.

None yet

3 participants