@chrismichaelps / pudu-lang-docgen
Documentation publishing for Pudu: articles, API references, navigation, search, and static websites
0.1.0Apache-2.01
InstallClose
Use @chrismichaelps/pudu-lang-docgen
Install this release
From your project, run:
pudu install @chrismichaelps/pudu-lang-docgen@0.1.0An exact version can install a new release immediately. Without a version, pudu follows the 72-hour minimum release age for new resolutions.
pudu install @chrismichaelps/pudu-lang-docgenThen import it
import PuduLangDocgen as PuduLangDocgenTo contribute
git clone https://github.com/chrismichaelps/pudu-lang-docgen
docgen.json
1{2 "metadata": [3 {4 "src": [5 {6 "files": [7 "**/*.pudu"8 ],9 "src": "src"10 }11 ],12 "dest": "api",13 "namespaceLayout": "nested",14 "sourceUrl": "https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/examples/site/src/{path}#L{line}"15 }16 ],17 "build": {18 "content": [19 {20 "files": [21 "**/*.md",22 "**/toc.yml",23 "rest/*.yml"24 ],25 "src": "docs"26 }27 ],28 "resource": [29 {30 "files": [31 "images/**"32 ],33 "src": "docs"34 }35 ],36 "template": [37 "default",38 "template"39 ],40 "globalMetadata": {41 "_appTitle": "Docgen Sample",42 "_appName": "Docgen Sample",43 "_appFooter": "Built with pudu-lang-docgen",44 "_enableSearch": true,45 "_appLogoPath": "images/logo.png",46 "_appFaviconPath": "images/logo.png"47 },48 "sitemap": {49 "baseUrl": "https://docs.example.org",50 "changefreq": "weekly"51 },52 "markdownEngineProperties": {53 "alerts": {54 "SECURITY": "alert alert-caution"55 }56 }57 }58}