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

Add syntax format to shell code examples #167

Open
dboehmer opened this issue Feb 21, 2024 · 0 comments
Open

Add syntax format to shell code examples #167

dboehmer opened this issue Feb 21, 2024 · 0 comments

Comments

@dboehmer
Copy link

Some code examples, e.g. on https://www.rexify.org/get/index.html, show shell code. I suggest to declare the code format using this Markdown syntax to get syntax highlighting. This makes shell command a little more human friendly.

Current Markdown syntax (example from https://www.rexify.org/docs/guides/start_using__r__ex.html):

    $ rex -T
    Tasks
      start_apache                   Start Apache service
      uptime                         Get the uptime of all servers
    Server Groups
      myservers                       mywebserver, mymailserver, myfileserver

Output (no syntax highlighting):

$ rex -T
Tasks
  start_apache                   Start Apache service
  uptime                         Get the uptime of all servers
Server Groups
  myservers                       mywebserver, mymailserver, myfileserver

Suggested Markdown syntax:

```console
$ rex -T
Tasks
  start_apache                   Start Apache service
  uptime                         Get the uptime of all servers
Server Groups
  myservers                       mywebserver, mymailserver, myfileserver
```

Output (colored, at least on GitHub):

$ rex -T
Tasks
  start_apache                   Start Apache service
  uptime                         Get the uptime of all servers
Server Groups
  myservers                       mywebserver, mymailserver, myfileserver

Is this supported in the build system of the website? Would you accept a PR applying this?

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

No branches or pull requests

1 participant