-
Notifications
You must be signed in to change notification settings - Fork 11.2k
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
Update README.md #1032
Update README.md #1032
Conversation
Reduce logo size and wrap with intro text with HTML table at top
Converting HTML table to Markdown now that image width is no issue
|
||
Welcome to Sui, a next generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the [Move](https://github.com/MystenLabs/awesome-move) programming language! Find everything you need within the [Sui Developer Guides](doc/src/learn/index.md) and supporting materials. | ||
| | | | ||
| ----------- | ----------- | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sadly, that doesn't seem to work as that row appears to be the delimiter between table headings and regular rows. I removed it, and it rendered as:
| | | | Welcome to Sui, a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the Move programming language! Find everything you need within the Sui Developer Guides and supporting materials below. |
I tried removing the top, empty row earlier but get this instead:
| ----------- | ----------- | | Welcome to Sui, a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the Move programming language! Find everything you need within the Sui Developer Guides and supporting materials below. |
Looks like the heading is required by most parsers:
https://stackoverflow.com/questions/17536216/create-a-table-without-a-header-in-markdown
README.md
Outdated
Welcome to Sui, a next generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the [Move](https://github.com/MystenLabs/awesome-move) programming language! Find everything you need within the [Sui Developer Guides](doc/src/learn/index.md) and supporting materials. | ||
| | | | ||
| ----------- | ----------- | | ||
| Welcome to Sui, a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by the [Move programming language](https://github.com/MystenLabs/awesome-move)! Find everything you need within the [Sui Developer Guides](doc/src/learn/index.md) and supporting materials below. | ![Sui icon](doc/static/Sui_Icon_Brand.png) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- The icon still seems a bit big--maybe we should embed it in HTML + resize? e.g.,
<img src="doc/static/Sui_Icon_Brand.png" alt="sui_icon" width="200"/>
- There's a lot of extra whitespace that hides the good README content that comes after the beginning. I'm not sure if that comes from the table or whitespace in the icon itself, but would be good to eliminate/minimize.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Heh, I went with HTML but converted to Markdown because I know Francois prefers it. Let me experiment.
Specify image width in HTML to reduce spacing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy with this as-is, as I think it's an improvement over the giant image of today! We can always tweak later.
Reduce logo size and wrap with intro text with HTML table at top