⌂Paradox
0.10.3
  • Overview
  • Getting Started
  • Configuration
  • Markdown
  • Directives
    • Organizing pages
    • Linking
    • Library dependencies
    • Snippet inclusion
    • Markdown file inclusion
    • Fiddle inclusion
    • Callouts
    • Variable Substitution Directives
    • CSS Friendliness
    • Alphabetical List of Directives
  • Variable Substitution
  • Groups
  • Customization
    • Templating
    • Theming
    • Pre-packaged Extensions
    • Generating pages with code
  • Validation
  • Single page HTML/PDF output
Paradox
⌂Paradox
0.10.3
  • Overview
  • Getting Started
  • Configuration
  • Markdown
  • Directives
    • Organizing pages
    • Linking
    • Library dependencies
    • Snippet inclusion
    • Markdown file inclusion
    • Fiddle inclusion
    • Callouts
    • Variable Substitution Directives
    • CSS Friendliness
    • Alphabetical List of Directives
  • Variable Substitution
  • Groups
  • Customization
    • Templating
    • Theming
    • Pre-packaged Extensions
    • Generating pages with code
  • Validation
  • Single page HTML/PDF output
  • Docs
  • Paradox
  • Directives

Directives

Directives are Paradox’ extension points for providing customized behavior over Markdown. Directive can be recognized by the @ sign which signifies a directive usage. Depending on the scope of the directive you will use a different kind of syntax. Use @ (for inline), @@ (leaf block), @@@(container block), @@@@ or more for nested container blocks.

More directives are available via extensions.

  • Organizing pages
    • @@@index container
    • @@toc block
  • Linking
    • External links
    • @ref link
    • Parameterized links
      • @scaladoc directive
      • @javadoc directive
      • @github directive
      • @extref directive
      • image.base_url
  • Library dependencies
    • Multiple dependencies
    • Symbolic version numbers
    • Bill of Materials (BOM) for Maven and Gradle
  • Snippet inclusion
    • @@snip block
      • Label filtering
      • Syntax highlighting
      • Tab Switching
    • snip.*.base_dir
    • Link to full source at GitHub
  • Markdown file inclusion
    • @@include block
    • include.*.base_dir
  • Fiddle inclusion
    • @@fiddle block
    • Source base directories
  • Callouts
    • @@@note callout
    • @@@warning callout
  • Variable Substitution Directives
    • @var
    • @@@vars
      • Customize delimiters with @@@vars
  • CSS Friendliness
    • @@@div
    • @span
    • Raw text in fenced blocks
  • Alphabetical List of Directives
The source code for this page can be found here.

Next: Organizing pages