Skip to content

docs: use html tables instead of md tables to account for ::: v-pre#330

Merged
JessicaSachs merged 3 commits intomainfrom
docs/parameter-table-2
Jan 28, 2022
Merged

docs: use html tables instead of md tables to account for ::: v-pre#330
JessicaSachs merged 3 commits intomainfrom
docs/parameter-table-2

Conversation

@ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Jan 28, 2022

We have to disable processing for parameters as well to avoid issues with potential examples {{name.first_name}} in there.

You can test this by adding a js like this:

 * @param format This does some crazy stuff `{{name}}`

Example output:

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Default</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
<tr>
  <td>format?</td>
  <td>string</td>
  <td></td>
  <td>

::: v-pre

This does some crazy stuff `{{name}}`

:::

  </td>
</tr>
  </tbody>
</table>

@Shinigami92

I decided to use ::: v-pre (with space) as used in the official documentation.
I will split any "omit ::: v-pre if unnecessary" optimizations into later PRs.

@ST-DDT ST-DDT added the c: docs Improvements or additions to documentation label Jan 28, 2022
@ST-DDT ST-DDT added this to the v6.0.0 - Project stability milestone Jan 28, 2022
@ST-DDT ST-DDT requested a review from a team as a code owner January 28, 2022 09:37
@ST-DDT ST-DDT self-assigned this Jan 28, 2022
Shinigami92
Shinigami92 previously approved these changes Jan 28, 2022
Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested it locally and it seems to work fine now

@Shinigami92 Shinigami92 requested a review from a team January 28, 2022 10:15
@JessicaSachs JessicaSachs merged commit a717637 into main Jan 28, 2022
@ST-DDT ST-DDT deleted the docs/parameter-table-2 branch January 28, 2022 22:05
bmenant pushed a commit to bmenant/faker that referenced this pull request Mar 11, 2022
…aker-js#330)

Co-authored-by: Jessica Sachs <jess@jessicasachs.io>
Co-authored-by: Shinigami <chrissi92@hotmail.de>
demipel8 pushed a commit to demipel8/faker that referenced this pull request Mar 11, 2022
…aker-js#330)

Co-authored-by: Jessica Sachs <jess@jessicasachs.io>
Co-authored-by: Shinigami <chrissi92@hotmail.de>
demipel8 pushed a commit to demipel8/faker that referenced this pull request Mar 11, 2022
…aker-js#330)

Co-authored-by: Jessica Sachs <jess@jessicasachs.io>
Co-authored-by: Shinigami <chrissi92@hotmail.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c: docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants