Skip to content

Commit daac250

Browse files
committed
🎨 format README
1 parent 54f8132 commit daac250

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ vuegen --directory docs/example_data/Earth_microbiome_vuegen_demo_notebook --rep
119119
Your input directory must follow a **nested folder structure**, where first-level folders are treated as **sections** and second-level folders as **subsections**, containing the components (plots, tables, networks, Markdown text, and HTML files).
120120

121121
Here is an example layout:
122+
122123
```
123124
report_folder/
124125
├── section1/
@@ -138,7 +139,7 @@ report_folder/
138139
> [!WARNING]
139140
> VueGen currently requires each section to contain at least one subsection folder. Defining only sections (with no subsections) or using deeper nesting levels (i.e., sub-subsections) will result in errors. In upcoming releases, we plan to support more flexible directory structures.
140141
141-
The titles for sections, subsections, and components are extracted from the corresponding folder and file names, and afterward, users can add descriptions, captions, and other details to the configuration file. Component types are inferred from the file extensions and names.
142+
The titles for sections, subsections, and components are extracted from the corresponding folder and file names, and afterward, users can add descriptions, captions, and other details to the configuration file. Component types are inferred from the file extensions and names.
142143
The order of sections, subsections, and components can be defined using numerical suffixes in folder and file names.
143144

144145
It's also possible to provide a configuration file instead of a directory:
@@ -258,28 +259,28 @@ This advanced case study demonstrates the application of VueGen in a real-world
258259
259260
**3. ChatBot Component**
260261

261-
This case study highlights VueGen’s capability to embed a chatbot component into a report subsection,
262+
This case study highlights VueGen’s capability to embed a chatbot component into a report subsection,
262263
enabling interactive conversations inside the report.
263264

264265
Two API modes are supported:
265266

266267
- **Ollama-style streaming chat completion**
267-
If a `model` parameter is specified in the config file, VueGen assumes the chatbot is using Ollama’s [/api/chat endpoint][ollama_chat].
268-
Messages are handled as chat history, and the assistant responses are streamed in real time for a smooth and responsive experience.
269-
This mode supports LLMs such as `llama3`, `deepsek`, or `mistral`.
268+
If a `model` parameter is specified in the config file, VueGen assumes the chatbot is using Ollama’s [/api/chat endpoint][ollama_chat].
269+
Messages are handled as chat history, and the assistant responses are streamed in real time for a smooth and responsive experience.
270+
This mode supports LLMs such as `llama3`, `deepsek`, or `mistral`.
270271

271272
> [!TIP]
272273
> See [Ollama’s website][ollama] for more details.
273274
274275
- **Standard prompt-response API**
275-
If no `model` is provided, VueGen uses a simpler prompt-response flow.
276-
A single prompt is sent to an endpoint, and a structured JSON object is expected in return.
277-
Currently, the response can include:
276+
If no `model` is provided, VueGen uses a simpler prompt-response flow.
277+
A single prompt is sent to an endpoint, and a structured JSON object is expected in return.
278+
Currently, the response can include:
278279
- `text`: the main textual reply
279280
- `links`: a list of source URLs (optional)
280281
- `HTML content`: an HTML snippet with a Pyvis network visualization (optional)
281282

282-
This response structure is currently customized for an internal knowledge graph assistant, but VueGen is being actively developed
283+
This response structure is currently customized for an internal knowledge graph assistant, but VueGen is being actively developed
283284
to support more flexible and general-purpose response formats in future releases.
284285

285286
> [!NOTE]

0 commit comments

Comments
 (0)