Improve site formatting #2183
Merged
Improve site formatting #2183
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Separate titles with blank lines - Separate code blocks with blank lines - Always use ``` blocks for examples - Use console for console (bash syntax highlighting does work well with example command output) - Start console examples with $ (highlight command and output differently and more friendly to other shells users)
When we want to show a minimal example with single import it looks cleaner and more minimal with a single line.
nirs
commented
Aug 24, 2024
| your.go | ||
| commands.go | ||
| here.go | ||
| main.go |
There was a problem hiding this comment.
Not sure if main.go is indented correctly. We can replace it with tree output which is much more clear to users and also used later below.
appName
├── cmd
│ ├── add.go
│ ├── your.go
│ ├── commands.go
│ └── here.go
└── main.go
There was a problem hiding this comment.
Yeah, feel free to change this if you prefer.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve site formatting to make it easier to maintain and have nicer output.
Preview: