settings.json.dist

{
  "databases": [
    {
      "host": "localhost",
      "name": "your-db-name",
      "user": "root",
      "password": "",
      "prefix": "",
      "type": "mysqli",
      "output": {
        "add_custom_files": 1,
        "folder": "C:\\temp\\db-documentation",
        "url": ""
      }
    }
  ],
  "config": {
    "create_csv": 0,
    "create_gitlab_wiki": 1,
    "create_marknotes": 0,
    "create_md": 1,
    "create_sql": 0,
    "csv_separator": ";",
    "get_credentials": 1,
    "get_detail": 1,
    "maxrows": 5,
    "timeformat": "d/m/Y H:i:s",
    "timezone": "Europe/Brussels"
  },
  "marknotes": {
    "templates": {
      "database": [
        "# Database @@DB_NAME@@",
        "",
        "%TOC_6%",
        "",
        "## Connection information",
        "",
        "%INCLUDE tables/.files/@@DB_NAME@@_connection.md%",
        "",
        "## Summary of tables",
        "",
        "%CSV tables/.files/@@DB_NAME@@_tables.csv%",
        "",
        "## List of tables",
        "",
        "%INCLUDE tables/*.md%"
      ],
      "table": [
        "# @@TABLE_NAME@@",
        "",
        "%INCLUDE .files/@@TABLE_NAME@@_description.md%",
        "",
        "%INCLUDE .files/@@TABLE_NAME@@_custom.md%",
        "",
        "## SQL",
        "",
        "```sql",
        "%INCLUDE .files/@@TABLE_NAME@@.sql%",
        "```",
        "",
        "## Fields",
        "",
        "%INCLUDE .files/@@TABLE_NAME@@_structure.md%",
        "",
        "## Samples",
        "",
        "%CSV .files/@@TABLE_NAME@@.csv%"
      ]
    }
  }
}