Edit Description¶

We demonstrate in the animation below how to add an example description to a Job inspected in Viewer. After toggling the description switch, we enter a series of headers in Markdown syntax ¹ and then add an equation from Wikipedia. Note that the editor also supports editing a document directly using the "what you see is what you get" approach ².

You can create headers by using # symbols, with the number of symbols indicating the level of the header (e.g., # Header1, ## Header2). To create emphasis, use asterisks or underscores around your text: one for italics (*italics* or _italics_), two for bold (**bold** or __bold__). For lists, use dashes, asterisks, or plus signs. For links, use square brackets around the linked text and parentheses around the URL like so: [link text](url).

The editor also supports the following formatting blocks:

Math block (using Katex syntax)
```
$$math
  \alpha \beta \gamma
  ...
$$
```

Code block (e.g. Python)

```python
  import numpy as np
  ...
```

Table

| id  | name         | unit    |
| --- | --- | --- |
| 001 | total_energy | hartree |
...

Checklist

1. [x] run structure relaxation
2. [ ] analyze results
...

For more information on the Markdown and the Markdown editor, please visit this documentation or the summary linked below¹.

Edit Tags¶

In order to edit Tags, modify the content in the relevant text field pressing "Enter" key after each word or phrase. The corresponding tag is consequently included on the same line, with the option to delete it made available to its right through the "X" icon button.

The aforementioned process is demonstrated in the animation below.

Edit Description¶

Edit Tags¶

Links¶