docgen.json

JSON90 lines2.8 KB

Copy pathGitHub ↗

1{2  "metadata": [3    {4      "src": [5        {6          "files": ["**/*.pudu"],7          "src": "../src"8        }9      ],10      "dest": "api",11      "namespaceLayout": "nested",12      "categoryLayout": "nested",13      "filter": "filterConfig.yml",14      "sourceUrl": "https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/{path}#L{line}"15    }16  ],17  "build": {18    "content": [19      {20        "files": ["**/*.md", "**/toc.yml", "**/*.yml"],21        "exclude": ["guides/includes/**", "guides/samples/**"],22        "src": "docs"23      }24    ],25    "overwrite": [26      {27        "files": ["**/*.md"],28        "src": "overwrite"29      }30    ],31    "resource": [32      {33        "files": ["images/**"]34      }35    ],36    "output": "_site",37    "template": ["default", "template"],38    "globalMetadata": {39      "_appTitle": "Pudu Docgen",40      "_appName": "Pudu Docgen",41      "_appLogoPath": "images/pudu-lang-short.png",42      "_appFaviconPath": "images/pudu-lang-short.png",43      "_appTouchIconPath": "images/pudu-lang-short.png",44      "_appOgImagePath": "images/pudu-lang-short.png",45      "_baseUrl": "https://www.pudu-lang-docgen.com",46      "_enableSearch": true,47      "_lang": "en",48      "_themeColor": "#5a78fa",49      "_meta": {50        "application-name": "Pudu Docgen"51      },52      "description": "Documentation publishing for Pudu: articles, API reference from Pudu sources, HTTP API reference, navigation, search, and static websites.",53      "keywords": ["pudu", "documentation", "static site", "api reference", "openapi"],54      "_copyright": "Chris M. Perez Santiago",55      "_footerLinks": [56        { "name": "Releases", "href": "https://github.com/chrismichaelps/pudu-lang-docgen/releases" },57        { "name": "Contribute", "href": "https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/CONTRIBUTING.md" },58        { "name": "Report an issue", "href": "https://github.com/chrismichaelps/pudu-lang-docgen/issues/new" },59        { "name": "Security", "href": "https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/SECURITY.md" },60        { "name": "Code of conduct", "href": "https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/CODE_OF_CONDUCT.md" },61        { "name": "License", "href": "https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/LICENSE" },62        { "name": "Pudu", "href": "https://www.pudu-lang.org/" }63      ]64    },65    "sitemap": {66      "baseUrl": "https://www.pudu-lang-docgen.com",67      "changefreq": "weekly",68      "priority": "0.5",69      "fileOptions": {70        "index.html": {71          "priority": "1.0"72        },73        "guides/**": {74          "priority": "0.8"75        }76      }77    },78    "gitContribute": {79      "repo": "https://github.com/chrismichaelps/pudu-lang-docgen",80      "branch": "main",81      "path": "website"82    },83    "markdownEngineProperties": {84      "alerts": {85        "SECURITY": "alert alert-caution"86      }87    }88  }89}90