buzsh

Mermaid.js Diagram Guidelines

Comprehensive styling and best practices for creating professional, accessible diagrams

Philosophy & Approach

These diagrams represent a refined approach to Mermaid.js visualization that prioritizes:

1. Universal Accessibility: Light/dark mode compatibility through strategic color choices
2. Visual Hierarchy: Clear information architecture using stroke weights and semantic colors

buzsh

import Foundation

let rootDirectory =
  CommandLine.arguments.count > 1
  ? CommandLine.arguments[1] : FileManager.default.currentDirectoryPath
let outputFile = "./codebase.md"
let debugMode = CommandLine.arguments.contains("-debug")

let allowedFileTypes: [String] = [] // ie. ["swift", "py"], leave blank to allow all file types

buzsh

// Configure your application file structure setup...

struct Constants {
  static let AppSupportFolderName = "MyApp"   // ie. This will be ~/Library/Application Support/MyApp/
}

/// App directories and their associated URLs
enum AppDirectory: String, CaseIterable {
  case userFiles    = "UserFiles"             // ie. This will be ~/Library/Application Support/MyApp/UserFiles/
  case models       = "UserFiles/Models"