Conventions

Symbols conventions

This documentation use some symbols for illustration purposes. Before you read on, make sure you've made yourself familiar with the following list of conventions.

To add a symbol to the sidebar add the following line in the markdown file:

---
icon: icon_path
---

Keep in mind that the icon path is not the icon name, the name of is material-pen but its path is material/pen

Todo

material-pen material/pen

The pen symbol is used when a specific page is under "construction" or when it's todo.

Linked page

material-vector-link material/vector-link

The link symbol is used when a page has no actual content but it's only a link to another page.

To automatically redirect the user use the following javascript in the markdown file

<script>
window.location.href = '/path_to_docs/'
</script>