github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/gen/docgen.yaml (about) 1 2 SourcePath: . 3 SourceExt: _doc.yaml 4 5 Categories: 6 - ID: Murex 7 Title: Murex 8 Description: 9 Templates: 10 - OutputPath: . 11 CategoryFile: 12 OutputExt: .md 13 CategoryTemplate: 14 DocumentTemplate: gen/root-md-doc.tmpl 15 16 - ID: commands 17 Title: Builtins Reference 18 Description: |- 19 {{ include "gen/commands-md-cat.inc.md" }} 20 21 Templates: 22 - OutputPath: docs/commands 23 CategoryFile: README.md 24 OutputExt: .md 25 CategoryTemplate: gen/commands-md-cat.tmpl 26 DocumentTemplate: gen/commands-md-doc.tmpl 27 28 - OutputPath: builtins/docs 29 CategoryFile: summaries.go 30 #OutputExt: _commands_docgen.go 31 CategoryTemplate: gen/commands-go-cat.tmpl 32 #DocumentTemplate: gen/commands-go-doc.tmpl 33 34 - ID: mkarray 35 Title: mkarray 36 Description: 37 Templates: 38 - OutputPath: docs/mkarray 39 CategoryFile: ../../gen/includes/autogenerated.mkarray.inc.md 40 OutputExt: .md 41 CategoryTemplate: gen/mkarray-md-cat.tmpl 42 DocumentTemplate: gen/mkarray-md-doc.tmpl 43 44 - ID: optional 45 Title: Optional Builtins Reference 46 Description: |- 47 {{ include "gen/optionals-md-cat.inc.md" }} 48 49 Templates: 50 - OutputPath: docs/optional 51 CategoryFile: README.md 52 OutputExt: .md 53 CategoryTemplate: gen/murex-md-cat.tmpl 54 DocumentTemplate: gen/commands-md-doc.tmpl 55 56 - ID: parser 57 Title: Parser Reference 58 Description: |- 59 {{ include "gen/parser-md-cat.inc.md" }} 60 61 Templates: 62 - OutputPath: docs/parser 63 CategoryFile: README.md 64 OutputExt: .md 65 CategoryTemplate: gen/murex-md-cat.tmpl 66 DocumentTemplate: gen/parser-md-doc.tmpl 67 68 # events: 69 - ID: events 70 Title: events 71 Description: 72 Templates: 73 - OutputPath: docs/events 74 CategoryFile: ../../gen/includes/autogenerated.events.inc.md 75 OutputExt: .md 76 CategoryTemplate: gen/events-md-cat.tmpl 77 DocumentTemplate: gen/events-md-doc.tmpl 78 79 # types: 80 - ID: types 81 Title: Data-Type Reference 82 Description: |- 83 {{ include "gen/types-md-cat.inc.md" }} 84 85 Templates: 86 - OutputPath: docs/types 87 CategoryFile: README.md 88 OutputExt: .md 89 CategoryTemplate: gen/murex-md-cat.tmpl 90 DocumentTemplate: gen/types-md-doc.tmpl 91 92 # special variables: 93 94 - ID: variables 95 Title: Special Variables 96 Description: 97 Templates: 98 - OutputPath: docs/variables 99 CategoryFile: ../../gen/includes/autogenerated.variables.inc.md 100 OutputExt: .md 101 CategoryTemplate: gen/variables-md-cat.tmpl 102 DocumentTemplate: gen/variables-md-doc.tmpl 103 104 # pipes: 105 106 # apis: 107 - ID: apis 108 Title: API Reference 109 Description: |- 110 {{ include "gen/apis-md-cat.inc.md" }} 111 112 Templates: 113 - OutputPath: docs/apis 114 CategoryFile: README.md 115 OutputExt: .md 116 CategoryTemplate: gen/murex-md-cat.tmpl 117 DocumentTemplate: gen/apis-md-doc.tmpl 118 119 # user guide: 120 - ID: user-guide 121 Title: User Guide 122 Description: |- 123 This section contains miscellaneous documents on using and configuring the 124 shell and Murex's numerous features. 125 Templates: 126 - OutputPath: docs/user-guide 127 CategoryFile: README.md 128 OutputExt: .md 129 CategoryTemplate: gen/userguide-md-cat.tmpl.md 130 DocumentTemplate: gen/userguide-md-doc.tmpl 131 132 # blog 133 - ID: blog 134 Title: Blog 135 Description: |- 136 Collection of Murex related documents and personal thoughts. 137 Templates: 138 - OutputPath: docs/blog 139 CategoryFile: README.md 140 OutputExt: .md 141 CategoryTemplate: gen/blog-md-cat.tmpl 142 DocumentTemplate: gen/blog-md-doc.tmpl 143 144 # changelog 145 - ID: changelog 146 Title: Change Log 147 Description: |- 148 Track new features, any breaking changes, and the release history here. 149 Templates: 150 - OutputPath: docs/changelog 151 CategoryFile: README.md 152 OutputExt: .md 153 CategoryTemplate: gen/changelog-md-cat.tmpl 154 DocumentTemplate: gen/changelog-md-doc.tmpl