construct-hub
construct-hub copied to clipboard
Fix minor formatting issues in API reference
The tables in the API reference appear slightly too close to the content above them in some contexts, and asterisks should if possible always be on the same line as last word in the table entry.
Code formatted text make it look like the paragraph/sentence is indented (more so than it does on other websites).
I also wonder if the code formatted text should have a different background color when the entries are in a table?
Screenshot taken from https://constructs.dev/packages/@cloudcamp/aws-runtime/v/0.0.1/
This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon. If you wish to exclude this issue from being marked as stale, add the "backlog" label.
I am also seeing formatting issues:
- Only the first comment line is interpreted with a CR. The other CRs are not interpreted
- Code block is one single line
- list is not formatted and generated a single line Example here https://constructs.dev/packages/aws-analytics-reference-architecture/v/1.16.0/api/DataLakeStorage?lang=typescript
@vgkowski Thanks for providing the example! I reckon it should be possible to fix those issues as well.
The issues I mentioned are not related to construct-hub but to jsii-docgen. The generated API.md from jsii-docgen has all the issues mentioned
https://github.com/cdklabs/jsii-docgen/issues/642