This is a test

By /

Signal In Static Documentation Style Test

This page demonstrates normal documentation text, inline code, multiline code blocks, commands, output, notes, tips, warnings, and danger callouts.

Normal Documentation

CalSync reads calendar information from a configured source and produces files that can be imported into another calendar system.

The main configuration is stored in config.json. Sensitive values should be placed in the .env file.

Note

NOTE

CalSync should be tested manually before it is configured to run as a scheduled process.

Tip

TIP

Begin with publish_enabled set to false. This lets you verify the generated files without publishing them.

Warning

WARNING

Do not commit your .env file, passwords, API keys, or other credentials to Git.

Danger

DANGER

Verify the configured output path before using any cleanup option. An incorrect path could result in deleting unrelated files.

Inline Code

Run python calsync.py after creating config.json. The value PUBLISH_ENABLED=false prevents automatic publishing during testing.

PowerShell Code Block

function Test-CalSyncConfiguration {
    param(
        [string]$ConfigPath = ".\config.json"
    )

    if (-not (Test-Path $ConfigPath)) {
        throw "Configuration file not found: $ConfigPath"
    }

    Write-Host "Configuration file found."
}

JSON Code Block

{
    "source": {
        "mailbox": "calendar@example.com",
        "folder": "Inbox"
    },
    "publishing": {
        "enabled": false,
        "output_directory": "./output"
    },
    "logging": {
        "level": "INFO"
    }
}

Command

python calsync.py –config config.json –verbose

Command With an Explicit Label

POWERSHELL
python .\calsync.py –config .\config.json –verbose

Console Output

OUTPUT
CalSync 1.0
Loading configuration: config.json
Connecting to mailbox
Found 14 calendar messages
Created 12 calendar files
Skipped 2 unchanged events
Completed successfully

Documentation Section With Embedded Callouts

CONFIGURATION OVERVIEW

Create a file named config.json in the CalSync application directory. 

{
    "publish_enabled": false,
    "output_directory": "./output"
}
WARNING

Leave publishing disabled until you have inspected the generated calendar files.

After testing is complete, change publish_enabled to true.

TIP

Save a backup copy of your working configuration before making production changes.

Troubleshooting Example

The following error indicates that CalSync cannot find its configuration:

ERROR OUTPUT
FileNotFoundError: config.json could not be located
RECOMMENDED FIX

Confirm that config.json is in the current directory, or pass its complete path with the --config option.

End of Style Test

This is normal article text after the documentation blocks. It lets you compare the callouts and code formatting against ordinary page content. 

function Get-CalSyncStatus {
    param(
        [string]$ConfigPath = ".\config.json"
    )

    if (-not (Test-Path $ConfigPath)) {
        throw "Configuration file not found: $ConfigPath"
    }

    Write-Output "CalSync configuration found."
}
Code language: PHP (php)
Scroll to Top