github.com/kubeshop/testkube@v1.17.23/docs/README.md (about)

     1  # Testkube docs
     2  
     3  You can find the docs here: https://docs.testkube.io
     4  
     5  ## How to edit the docs
     6  
     7  **System requirements:**
     8  - [npm](https://nodejs.org/en/download)
     9  
    10  If you're editing the docs, follow this workflow:
    11  
    12  1. Install dependencies with `npm install`
    13  2. Spin up local development with `npm run start`
    14  3. Update the docs inside the `/docs` folder
    15  4. Make sure to add the new document in the `sidebar.json` file:
    16  
    17  ```diff
    18  {
    19    type: "category",
    20    label: "Concepts",
    21    items: [
    22      {
    23        type: "category",
    24        label: "Tests",
    25        items: [
    26          "concepts/tests/tests-creating",
    27          "concepts/tests/tests-running",
    28          "concepts/tests/tests-getting-results",
    29          "concepts/tests/tests-variables",
    30  +       "concepts/new-concept"
    31        ],
    32      },
    33  }
    34  ```
    35  
    36  5. You can preview the changes locally in your browser: http://localhost:3000
    37  
    38  ### How to style the docs
    39  
    40  #### Warning signs
    41  
    42  If you want to add a warning/info message like the below, use [Docusuarus Admonitions](https://docusaurus.io/docs/markdown-features/admonitions).
    43  
    44  ![Warning signs](./docs/img/docusaurus-admonitions.png)
    45  
    46  
    47  #### Code blocks title
    48  
    49  If the content of the code blocks refers to a file, use Docusaurus [Code Block title](https://docusaurus.io/docs/markdown-features/code-blocks#code-title).
    50  
    51  ![Code Block title](./docs/img/docusaurus-codeblock-title.png)
    52  
    53  **Don't:**
    54  
    55  ````md
    56  file.js
    57  
    58  ```js
    59  file
    60  content
    61  ```
    62  ````
    63  
    64  **Do:**
    65  
    66  ````md
    67  ```js title="file.js"
    68  file
    69  content
    70  ```
    71  ````
    72