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

ADR 2.0.x wrong code block / indentation #643

Open
bwbroersma opened this issue Jan 14, 2025 · 0 comments
Open

ADR 2.0.x wrong code block / indentation #643

bwbroersma opened this issue Jan 14, 2025 · 0 comments

Comments

@bwbroersma
Copy link

See DesignRules.md#L539-L549:

      <div class="example">
         <p>An example of a base path for an API with current version 1.0.2:</p>
         <pre>https://api.example.org/v1/</pre>
         <pre>version: '1.0.2'</pre>
         <pre>servers:
                  - description: test environment  
                  url: https://api.test.example.org/v1/  
                  - description: production environment  
                  url: https://api.example.org/v1/  
         </pre>
      </div>

The server part, and maybe version looks like a partial OpenAPI specification in YAML format, but currently it's incorrectly highlighted.
If it is indeed YAML it should be:

<pre class="yaml">YAML</pre>

Maybe version and server should be in one code block if it's indeed one YAML.

BTW YAML is supported by highlightjs.

Related:

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