Test Content

A page for testing and previewing the presentation of common content components.

Admonitions

Currently we support 5 admonition types: note, tip, important, warning, caution.

Admonition titles are optional but recommended.

This is a note

Notebooks contain cells which help the user to evaluate VQL queries on the server. Remember that notebook queries always run on the server and not on the original client. This post-processing query will parse the prefetch files on the server itself.

This is a tip

In a secure installation you should remove the CA.private_key section from the server config and keep it offline. You only need it to create new API keys using the velociraptor config api_client command, and the server does not need it in normal operations.

This is important

It is good practice to always make a backup copy of your config file both before upgrading and after upgrading, just in case changes are made by the upgrade!

This is a warning!

The reformatted VQL is inserted back into the original YAML file, replacing the old VQL while preserving the rest of the structure! Make sure you have backup copies of your artifacts before applying reformat to them, just in case you’re dissatisfied with the resultant formatting.

This is a caution!

Deleting the server’s private key material without a backup will make it impossible to decrypt collected data and will permanently break your deployment.

Images

Images follow the same syntax as links but are prefixed with an exclamation mark !.

Raster types

An inline PNG with height < 200px.

SVG

Fontawesome Icons

An icon.

Explicit Links

Here is an internal link and also an external link and a relative link and a link to a file resource.

Implicit Links

https://commonmark.org

user@example.com

Headings

Headings from level 1 to 6 are supported.

Level 1 Heading

Level 2 Heading

Level 3 Heading

Level 4 Heading

Level 5 Heading

Level 6 Heading

Emphasis (Bold and Italic)

You can wrap text in asterisks or underscores to add style.

This text is italicized. This text is bold. This text is both bold and italic.

Lists

CommonMark supports both ordered (numbered) and unordered (bulleted) lists.

Unordered

Item A
Item B
- Sub-item B1
- Sub-item B2

Ordered

First item
Second item
Third item

Blockquotes

Blockquotes are used to indicate text quoted from another source.

“Markdown is a text-to-HTML conversion tool for web writers.” — John Gruber

Inline Code and Code Blocks

Use backticks for inline code and triple backticks for blocks.

We currently support browser, python, yaml, sql, json, bash, powershell, vql, text, shell syntax highlighting via Hugo’s built-in Chroma highlighter (the vql tag is aliased to the sql lexer since VQL is SQL-derived).

VQL example

SELECT read_file(path="C:/Windows/notepad.exe", accessor="file")
FROM scope()

```vql
SELECT read_file(path="C:/Windows/notepad.exe", accessor="file")
FROM scope()
```

Python example

def hello_world():
    print("Hello, CommonMark!")

```python
def hello_world():
    print("Hello, CommonMark!")
```

Horizontal Rules

You can create a thematic break using three or more hyphens, asterisks, or underscores.

This is the next paragraph.

Escaping Characters

If you want to show a literal character that would otherwise be interpreted as Markdown syntax, use a backslash \.

*This is not italic*

Guidelines for creating image content Linting