Skip to content

Commit

Permalink
Update vitepress version to latest
Browse files Browse the repository at this point in the history
  • Loading branch information
guerler committed Nov 4, 2024
1 parent 607e7a1 commit 7a9780c
Show file tree
Hide file tree
Showing 8 changed files with 1,437 additions and 309 deletions.
2 changes: 1 addition & 1 deletion docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export default defineConfig({
]
},
{
text: 'Core Component',
text: 'Vue Component',
items: [
{ text: 'Introduction', link: '/content/vue-introduction' },
{ text: 'Utilities', link: '/content/vue-utilities' }
Expand Down
2 changes: 1 addition & 1 deletion docs/content/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ npm run dev

Congratulations! Your Galaxy visualization repository is set up and ready for development. Follow the instructions on the splash screen and refer to these docs as you build your custom visualization.

When you’re ready to publish, refer to the **How to Publish** section to share your visualization with the Galaxy community.
When you’re ready to publish, refer to the **Deploy to Galaxy** section to share your visualization with the Galaxy community.

Thank you for your contribution!
2 changes: 1 addition & 1 deletion docs/content/vue-introduction.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Core Component
# Vue Component

The `GalaxyCharts` core component is used to embed a JavaScript-based visualization by placing the visualization code within its `#default` slot. This component parses static `config` options and the XML visualization wrapper to render both the viewport and input form.

Expand Down
18 changes: 9 additions & 9 deletions docs/content/xml-inputs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Inputs
# Inputs

You can specify input elements within the settings and tracks sections, allowing users to parameterize and customize their visualization. Galaxy Charts currently supports the following input types: `boolean`, `color`, `data`, `float`, `integer`, `select`, and `text`.

Below is a template for a generic input element. It includes attributes such as `label`, `help`, `name`, and `type`, along with an optional `data` array used for `select` inputs:

```md
```xml
<input>
<label>My Input Label</label>
<help>My Input Help</help>
Expand All @@ -24,7 +24,7 @@ Below is a template for a generic input element. It includes attributes such as

Boolean inputs are useful to display yes/no options to the user e.g.

```md
```xml
<input>
<label>My Boolean Label</label>
<help>My Boolean Help</help>
Expand All @@ -50,7 +50,7 @@ Translates to:

Users may also select colors, this can be particular useful to distinguish data tracks e.g. in bar or line diagrams:

```md
```xml
<input>
<label>My Color Label</label>
<help>My Color Help</help>
Expand Down Expand Up @@ -79,7 +79,7 @@ Translates to:

Using a `data` input field you can allow users to select a dataset from Galaxy:

```md
```xml
<input>
<label>My Data Label</label>
<help>My Data Help</help>
Expand All @@ -103,7 +103,7 @@ Translates to:

## Float Input

```md
```xml
<input>
<label>My Float Label</label>
<help>My Float Help</help>
Expand Down Expand Up @@ -140,7 +140,7 @@ Translates to:

## Integer Input

```md
```xml
<input>
<label>My Integer Label</label>
<help>My Integer Help</help>
Expand All @@ -153,7 +153,7 @@ Translates to:

## Select Input

```md
```xml
<input>
<label>My Select Label</label>
<help>My Select Help</help>
Expand Down Expand Up @@ -191,7 +191,7 @@ Translates to:

Last but not least, `text` inputs can be declared.

```md
```xml
<input>
<label>My Text Label</label>
<help>My Text Help</help>
Expand Down
2 changes: 1 addition & 1 deletion docs/content/xml-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Galaxy Visualizations are configured using XML files. The files contain Visualization specific attributes such as the `name`, `description` and the associated npm package details.

```md
```xml
<visualization name="MY_VISUALIZATION">
<description>MY_DESCRIPTION</description>
<requirements>
Expand Down
6 changes: 3 additions & 3 deletions docs/content/xml-sections.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `settings` section includes an `array` of `input` elements that allow users to customize the visualization. These customization options are also available when embedding the visualization in Galaxy workflow reports. Below is an example of a `settings` section with a single `text` input element:

```md
```xml
<settings>
<input>
<label>Setting: Text</label>
Expand All @@ -19,7 +19,7 @@ The `settings` section includes an `array` of `input` elements that allow users

The `specs` section includes an `array` of static `key-value` pairs for general use, such as:

```md
```xml
<specs>
<my_key>my_value</my_key>
...
Expand All @@ -30,7 +30,7 @@ The `specs` section includes an `array` of static `key-value` pairs for general

The `tracks` section includes an `array` of `input` elements that allow users to configure individual data tracks, for example:

```md
```xml
<tracks>
<input>
<label>Track: Color</label>
Expand Down
Loading

0 comments on commit 7a9780c

Please sign in to comment.