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.

Sign up for GitHub

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

Jump to bottom

Improve site formatting #2183

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Improve site formatting #2183

wants to merge 3 commits into from

Commits on Aug 24, 2024

  1. Improve site formatting 

    - 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)
    @nirs
    nirs committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    4220a0b View commit details
    Browse the repository at this point in the history

  2. Unify indentation in example project structure

    @nirs
    nirs committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    08fa116 View commit details
    Browse the repository at this point in the history

  3. Use single import line in the trivial examples 

    When we want to show a minimal example with single import it looks
cleaner and more minimal with a single line.
    @nirs
    nirs committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    612f06f View commit details
    Browse the repository at this point in the history