---
sidebar_label: 'Preface'
sidebar_position: 1
---

<!-- truncate -->
import CodeBlock from '@site/src/components/CodeBloack';


# Preface


<div className="head">Document Conventions</div><br/>

<div className="text" style={{ fontSize:'28px' }}>Admonitions and Call-Outs</div>



- ℹ️ **Info**: Additional detail about a topic will be called out with the "info" symbol.

- 💡 **Tip**: Tips and advice will appear with a "lightbulb" admonition.

- ⚠️ **Warning**: Warnings and strong recommendations will appear next to a caution exclamation.

- ❗ **Crucial**: Crucial advice and information will appear next to a red exclamation.<br/>


<div className="head">Single-line Commands and Code</div>
<div className="text">If instructed to type a single command, it will be displayed in a monospace font and highlighted like this
example:</div>

<CodeBlock code={`ipa -vvv cert-find --all
`} /><br/>


<div className="head"> Multi-line Commands, Code / File Contents</div>
<div className="text">If instructed to type multi-line commands, create or modify code blocks and or file contents the
information will be monospaced and placed in a callout box like this example:</div>

<CodeBlock code={`require 'sinatra'
get '/hi' do
  "Hello World!"
end`} /><br/>