Skip to content

Conventions

This documentation use some symbols for illustration purposes. Before you read on, please make sure you've made yourself familiar with the following list of conventions on this page, as they are used quite frequently.


General Badges

The badges in this section are for general use.


Flags

These icons denote / mark a particular item with a specific category type. Use these to indicate that a feature or service is experimental, dangerous, setting, or required.

Examples

Default <!-- md:flag -->

Experimental <!-- md:flag experimental -->

Required <!-- md:flag required -->

Customization <!-- md:flag customization -->

Metadata <!-- md:flag metadata -->

Dangerous <!-- md:flag dangerous -->

Multiple <!-- md:flag multiple -->

Setting <!-- md:flag setting -->


Controls

These icons deonote what type of control a specified setting uses if the settings are controlled by a graphical user interface.

Examples

default <!-- md:control -->

toggle <!-- md:control toggle -->

toggle on <!-- md:control toggle_on -->

toggle off <!-- md:control toggle_off -->

textbox <!-- md:control textbox -->

dropdown <!-- md:control dropdown -->

button <!-- md:control button -->

slider <!-- md:control slider -->

docker volume <!-- md:control volume -->

env variable <!-- md:control env -->

     <!-- md:control color #E5E5E5 #121315 -->


Release Type

The tag symbol in conjunction with a version number denotes when a specific feature or functionality was added. Make sure you're at least on this version if you want to use the specified feature or functionality.

Examples

default <!-- md:version -->

stable <!-- md:version stable -->

development <!-- md:version development -->

1.6.1 <!-- md:version 1.6.1 -->

1.6.1 <!-- md:version stable-1.6.1 -->

1.6.1 <!-- md:version development-1.6.1 -->


Default Value

Denotes what the default value is for a particular setting. If you ever change a setting and wish to revert back to the default value; this is the value you should use.

Examples

Specified setting has a default value <!-- md:default -->

Specified setting has no default value and is empty <!-- md:default none -->

Specified setting is automatically computed by the app <!-- md:default computed -->

false Default value is false <!-- md:default false -->


Command

Denotes that this item is a command which can be executed via a terminal, command prompt or some other console.

Examples

Specified setting has a default value <!-- md:command -->

-s, --start Specified setting has a default value <!-- md:command -s, --start -->


3rd Party

Denotes that this item is provided by a 3rd party service or app which is not directly associated with this application.

Examples

<!-- md:3rdparty -->

mike <!-- md:3rdparty mike -->


Documentation

Denotes that this item has additional documentation which the user can click the icon for and be taken to another site / page

Examples

<!-- md:docs -->

View Docs <!-- md:docs ../advanced/services/blocklist.configserver/ self -->

View Docs <!-- md:docs ../advanced/services/blocklist.configserver/ new -->


Plugin

Denotes that this item requires a specific plugin in order to function.

Examples

<!-- md:plugin -->

name <!-- md:plugin name -->

[typeset] – built-in With Details <!-- md:plugin [typeset] – built-in -->



Feature

Denotes a feature available within the app.

Examples

<!-- md:feature -->

name <!-- md:feature name -->



Requires File

Denotes that a particular feature or functionality looks for, or requires a specific file on your system.

Examples

<!-- md:requires -->

/etc/csf/csf.conf <!-- md:requires /etc/csf/csf.conf -->



Source File

Denotes a feature's source file location. This explains what file the feature or setting can be found in.

Examples

<!-- md:source -->

/etc/csf/csf.conf <!-- md:source /etc/csf/csf.conf -->



Configurable Settings

Denotes that this item is a configurable setting. Using this requires that you place it within a heading, typically h4

Examples

archive

#### <!-- md:setting config.archive -->


Markdown Extension

This symbol denotes that the thing described is a Markdown element. When adding links, ensure you create a reference-style link

Examples

<!-- md:markdown -->

admonition <!-- md:markdown [admonition][Admonition] -->

:   <!-- md:markdown [admonition][Admonition] -->

[Admonition]: https://python-markdown.github.io/extensions/admonition/



File Preview

Creates a badge which allows a user to download a file. Badges will contain three sections:

  1. View Example
  2. Download Example
  3. .ext filename extension
Examples

Icon Only

`` Left Aligned

Right Aligned ``

<!-- md:file something.rar --> Right Aligned

<!-- md:file something.rar left → Left Aligned

<!-- md:file something.rar right → Right Aligned



Supporter

The pumping heart symbol denotes a person who has been generous enough to support our development through donations.

Examples

Backer





Options

Options are another form of setting which lists what the option does, and then examples of how it works.

rss.enabled

true This option specifies whether the plugin is enabled when building your project. If you want to speed up local builds, you can use an [environment variable][mkdocs.env]:

plugins:
  - rss:
      enabled: !ENV [CI, false]
rss.match_path

.* This option specifies which pages should be included in the feed. For example, to only include blog posts in the feed, use the following regular expression:

plugins:
  - rss:
      match_path: blog/posts/.*




General Examples

These are just generic examples with no specific purpose. They demonstrate how badges can be used.


DEBUG_ENABLED

2.0.0 false ``

This is an example setting.

#### <!-- md:flag setting --> DEBUG_ENABLED 
<!-- md:version stable-2.0.0 --> <!-- md:default `false` --> <!-- md:flag required --> <!-- md:file test.zip -->

This is an example setting.




Icons

Some parts of this documentation may also display icons in one of two ways

  1. Using HTML 
    <i class="axd ax-file axd-xs"></i> [View Raw Version](https://license.md/wp-content/uploads/2022/06/gpl-3.0.txt)
  2. Using Markdown 
    :aetherx-axd-file:



Emoji in Tooltips

You can display an emoji / icon search bar which can be called from a codeblock tooltip as shown below.

<span class="twemoji">
    <img src="/.icons/aetherx/axs/csf-logo-1.svg" alt="CSF Logo" width="32"> <!-- (1)! -->
</span>

  1. Enter a few keywords to find the perfect icon using our [icon search] and click on the shortcode to copy it to your clipboard:




    Use the following to search our database for a specific icon which is available through our documentation.

      Tip: Enter some keywords to find icons and emojis and click on the shortcode to copy it to your clipboard.