├── .gitignore ├── .markdownlint.jsonc ├── LEGAL.txt └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | _md-cli/* 2 | 3 | # Markdown Project Tool 4 | _md-cli/ 5 | 6 | .idea/ 7 | .vscode/* 8 | .DS_Store 9 | -------------------------------------------------------------------------------- /.markdownlint.jsonc: -------------------------------------------------------------------------------- 1 | { 2 | // This file configures markdownlinter in VS Code to ignore Markdown style deviations that 3 | // DocWorks requires, such as HTML anchors. To work, this file must be in the same repo as the 4 | // affected docs. For more information, see https://github.com/DavidAnson/vscode-markdownlint#configure. 5 | 6 | // Default state for all rules 7 | "default": true, 8 | 9 | // Path to configuration file to extend 10 | "extends": null, 11 | 12 | // MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time 13 | "MD001": true, 14 | 15 | // MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading 16 | "MD002": { 17 | // Heading level 18 | "level": 1 19 | }, 20 | 21 | // MD003/heading-style/header-style - Heading style 22 | "MD003": { 23 | // Heading style 24 | "style": "consistent" 25 | }, 26 | 27 | // MD004/ul-style - Unordered list style 28 | "MD004": { 29 | // List style 30 | "style": "dash" 31 | }, 32 | 33 | // MD005/list-indent - Inconsistent indentation for list items at the same level 34 | "MD005": true, 35 | 36 | // MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line 37 | "MD006": true, 38 | 39 | // MD007/ul-indent - Unordered list indentation 40 | "MD007": { 41 | // Spaces for indent 42 | "indent": 2, 43 | // Whether to indent the first level of the list 44 | "start_indented": false, 45 | // Spaces for first level indent (when start_indented is set) 46 | "start_indent": 2 47 | }, 48 | 49 | // MD009/no-trailing-spaces - Trailing spaces 50 | "MD009": false, 51 | //{ 52 | // Spaces for line break 53 | // "br_spaces": 2, 54 | // Allow spaces for empty lines in list items 55 | // "list_item_empty_lines": false, 56 | // Include unnecessary breaks 57 | // "strict": false 58 | //}, 59 | 60 | // MD010/no-hard-tabs - Hard tabs 61 | "MD010": { 62 | // Include code blocks 63 | "code_blocks": true, 64 | // Fenced code languages to ignore 65 | "ignore_code_languages": [], 66 | // Number of spaces for each hard tab 67 | "spaces_per_tab": 1 68 | }, 69 | 70 | // MD011/no-reversed-links - Reversed link syntax 71 | "MD011": true, 72 | 73 | // MD012/no-multiple-blanks - Multiple consecutive blank lines 74 | "MD012": { 75 | // Consecutive blank lines 76 | "maximum": 1 77 | }, 78 | 79 | // MD013/line-length - Line length 80 | "MD013": { 81 | // Number of characters 82 | "line_length": 100, 83 | // Number of characters for headings 84 | "heading_line_length": 100, 85 | // Number of characters for code blocks 86 | "code_block_line_length": 10000, 87 | // Include code blocks 88 | "code_blocks": true, 89 | // Include tables 90 | "tables": true, 91 | // Include headings 92 | "headings": true, 93 | // Include headings 94 | "headers": true, 95 | // Strict length checking 96 | "strict": false, 97 | // Stern length checking 98 | "stern": false 99 | }, 100 | 101 | // MD014/commands-show-output - Dollar signs used before commands without showing output 102 | "MD014": true, 103 | 104 | // MD018/no-missing-space-atx - No space after hash on atx style heading 105 | "MD018": true, 106 | 107 | // MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading 108 | "MD019": true, 109 | 110 | // MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading 111 | "MD020": true, 112 | 113 | // MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading 114 | "MD021": true, 115 | 116 | // MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines 117 | "MD022": { 118 | // Blank lines above heading 119 | "lines_above": 1, 120 | // Blank lines below heading 121 | "lines_below": 1 122 | }, 123 | 124 | // MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line 125 | "MD023": true, 126 | 127 | // MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content 128 | "MD024": { 129 | // Only check sibling headings 130 | "allow_different_nesting": false, 131 | // Only check sibling headings 132 | "siblings_only": false 133 | }, 134 | 135 | // MD025/single-title/single-h1 - Multiple top-level headings in the same document 136 | "MD025": { 137 | // Heading level 138 | "level": 1, 139 | // RegExp for matching title in front matter 140 | "front_matter_title": "^\\s*title\\s*[:=]" 141 | }, 142 | 143 | // MD026/no-trailing-punctuation - Trailing punctuation in heading 144 | "MD026": { 145 | // Punctuation characters 146 | "punctuation": ".,;:!。，；：！" 147 | }, 148 | 149 | // MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol 150 | "MD027": true, 151 | 152 | // MD028/no-blanks-blockquote - Blank line inside blockquote 153 | "MD028": true, 154 | 155 | // MD029/ol-prefix - Ordered list item prefix 156 | "MD029": { 157 | // List style 158 | "style": "one_or_ordered" 159 | }, 160 | 161 | // MD030/list-marker-space - Spaces after list markers 162 | "MD030": { 163 | // Spaces for single-line unordered list items 164 | "ul_single": 1, 165 | // Spaces for single-line ordered list items 166 | "ol_single": 1, 167 | // Spaces for multi-line unordered list items 168 | "ul_multi": 1, 169 | // Spaces for multi-line ordered list items 170 | "ol_multi": 1 171 | }, 172 | 173 | // MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines 174 | "MD031": { 175 | // Include list items 176 | "list_items": true 177 | }, 178 | 179 | // MD032/blanks-around-lists - Lists should be surrounded by blank lines 180 | "MD032": true, 181 | 182 | // MD033/no-inline-html - Inline HTML 183 | "MD033": { 184 | // Allowed elements 185 | "allowed_elements": ["a"] 186 | }, 187 | 188 | // MD034/no-bare-urls - Bare URL used 189 | "MD034": true, 190 | 191 | // MD035/hr-style - Horizontal rule style 192 | "MD035": { 193 | // Horizontal rule style 194 | "style": "consistent" 195 | }, 196 | 197 | // MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading 198 | "MD036": { 199 | // Punctuation characters 200 | "punctuation": ".,;:!?。，；：！？" 201 | }, 202 | 203 | // MD037/no-space-in-emphasis - Spaces inside emphasis markers 204 | "MD037": true, 205 | 206 | // MD038/no-space-in-code - Spaces inside code span elements 207 | "MD038": true, 208 | 209 | // MD039/no-space-in-links - Spaces inside link text 210 | "MD039": true, 211 | 212 | // MD040/fenced-code-language - Fenced code blocks should have a language specified 213 | "MD040": true, 214 | 215 | // MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading 216 | "MD041": { 217 | // Heading level 218 | "level": 1, 219 | // RegExp for matching title in front matter 220 | "front_matter_title": "^\\s*title\\s*[:=]" 221 | }, 222 | 223 | // MD042/no-empty-links - No empty links 224 | "MD042": true, 225 | 226 | // MD043/required-headings/required-headers - Required heading structure 227 | "MD043": false, 228 | 229 | // MD044/proper-names - Proper names should have the correct capitalization 230 | "MD044": { 231 | // List of proper names 232 | "names": [], 233 | // Include code blocks 234 | "code_blocks": true, 235 | // Include HTML elements 236 | "html_elements": true 237 | }, 238 | 239 | // MD045/no-alt-text - Images should have alternate text (alt text) 240 | "MD045": true, 241 | 242 | // MD046/code-block-style - Code block style 243 | "MD046": { 244 | // Block style 245 | "style": "consistent" 246 | }, 247 | 248 | // MD047/single-trailing-newline - Files should end with a single newline character 249 | "MD047": true, 250 | 251 | // MD048/code-fence-style - Code fence style 252 | "MD048": { 253 | // Code fence style 254 | "style": "consistent" 255 | }, 256 | 257 | // MD049/emphasis-style - Emphasis style should be consistent 258 | "MD049": { 259 | // Emphasis style should be consistent 260 | "style": "consistent" 261 | }, 262 | 263 | // MD050/strong-style - Strong style should be consistent 264 | "MD050": { 265 | // Strong style should be consistent 266 | "style": "consistent" 267 | }, 268 | 269 | // MD051/link-fragments - Link fragments should be valid 270 | "MD051": true, 271 | 272 | // MD052/reference-links-images - Reference links and images should use a label that is defined 273 | "MD052": true, 274 | 275 | // MD053/link-image-reference-definitions - Link and image reference definitions should be needed 276 | "MD053": true 277 | } -------------------------------------------------------------------------------- /LEGAL.txt: -------------------------------------------------------------------------------- 1 | Copyright (c) 2020-Present VMware, Inc. or its affiliates All rights reserved. 2 | 3 | Unauthorized use, copying or distribution of this source code or documentation 4 | via any medium is strictly prohibited without the express written consent of 5 | VMware, Inc. or its affiliates. 6 | 7 | THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, 8 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 9 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 10 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 11 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 12 | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 13 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # docs-tap 2 | 3 | This repo is no longer in use. To contribute to the Tanzu Application Platform documentation, 4 | open a merge request in [GitLab](https://gitlab.eng.vmware.com/tanzu-docs/docs-tap). 5 | --------------------------------------------------------------------------------