Closed mamcx closed 1 year ago
Code blocks won't render properly inside a table. I think if code blocks are required in param description then we need to introduce an option to display parameters in a list style (rather than a table) - like the HTML theme does.
Well, the thing is that from the POW of the writer, the code block is not "inside". Why is it not enough to have space between params & code?
Sorry I don't fully understand - do you have an example of desired output?
Sure:
Creates a new `SpacetimeDBClient` database client and set the initial parameters.
#### Parameters
| Name | Type | Description |
| :---------------- | :------------------------- | :----------------------------------------------------------------------------------------- |
| `host` | `string` | The host of the spacetimeDB server |
| `name_or_address` | `string` | The name or address of the spacetimeDB module
```ts
const host = "ws://localhost:3000";
ok - you could use block tags to split up the comments, like:
/**
* Creates a new `SpacetimeDBClient` database client and set the initial parameters.
*
* @param host The host of the spacetimeDB server
*
* @example
*
* ```ts
* const host = "ws://localhost:3000";
* ```
*/
When I add a code block for show how use the API at the end it gets mangled because is inlined:
Shows as: