Skip to content

Commit 9ddca02

Browse files
sgrabandsgraband
authored
Updating publishing guide and set markdown formatter (#14553)
- Set formatter for markdown files - Format all markdown files - Update publishing guide Signed-off-by: Simon Graband <[email protected]>
1 parent fb09901 commit 9ddca02

File tree

99 files changed

+961
-613
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+961
-613
lines changed

‎.theia/settings.json

+9-1
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,13 @@
1111
"editor.tabSize": 2
1212
},
1313
"typescript.tsdk": "node_modules/typescript/lib",
14-
"clang-format.language.typescript.enable": false
14+
"clang-format.language.typescript.enable": false,
15+
"[markdown]": {
16+
"editor.defaultFormatter": "davidanson.vscode-markdownlint"
17+
},
18+
"markdownlint.config": {
19+
"MD032": false, // don't require blank line around lists
20+
"MD033": false, // allow inline html
21+
"MD041": false // don't require h1 in first line
22+
},
1523
}

‎.vscode/extensions.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
44
// List of extensions which should be recommended for users of this workspace.
55
"recommendations": [
6-
"dbaeumer.vscode-eslint"
6+
"dbaeumer.vscode-eslint",
7+
"DavidAnson.vscode-markdownlint"
78
],
89
// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
910
"unwantedRecommendations": []

‎.vscode/settings.json

+9-1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@
5151
"editor.tabSize": 2,
5252
"editor.defaultFormatter": "vscode.json-language-features",
5353
},
54+
"[markdown]": {
55+
"editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
56+
},
5457
"typescript.tsdk": "node_modules/typescript/lib",
5558
"files.insertFinalNewline": true,
5659
"clang-format.language.typescript.enable": false,
@@ -63,5 +66,10 @@
6366
"editor.defaultFormatter": "vscode.typescript-language-features",
6467
"typescript.preferences.quoteStyle": "single",
6568
"editor.tabSize": 4,
66-
}
69+
},
70+
"markdownlint.config": {
71+
"MD032": false, // don't require blank line around lists
72+
"MD033": false, // allow inline html
73+
"MD041": false // don't require h1 in first line
74+
},
6775
}

‎CODE_OF_CONDUCT.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ This Code of Conduct applies within all project spaces, and it also applies when
4343

4444
## Enforcement
4545

46-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
46+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <[email protected]>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
4747

4848
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
4949

5050
## Attribution
5151

52-
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
52+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
5353

54-
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
54+
For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq>
5555

5656
<div id="theia-logo" align="left">
5757
<br />

‎CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ We follow the coding guidelines described
5555
Before your contribution can be accepted by the project team contributors must
5656
electronically sign the Eclipse Contributor Agreement (ECA).
5757

58-
* https://www.eclipse.org/legal/ECA.php
58+
* <https://www.eclipse.org/legal/ECA.php>
5959

6060
Commits that are provided by non-committers must have a Signed-off-by field in
6161
the footer indicating that the author is aware of the terms by which the
@@ -64,7 +64,7 @@ additionally have an Eclipse Foundation account and must have a signed Eclipse
6464
Contributor Agreement (ECA) on file.
6565

6666
For more information, please see the Eclipse Committer Handbook:
67-
https://www.eclipse.org/projects/handbook/#resources-commit
67+
<https://www.eclipse.org/projects/handbook/#resources-commit>
6868

6969
## Sign your work
7070

‎NOTICE.md

+63-65
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This content is produced and maintained by the Eclipse Theia project.
44

5-
* Project home: https://projects.eclipse.org/projects/ecd.theia
5+
* Project home: <https://projects.eclipse.org/projects/ecd.theia>
66

77
## Trademarks
88

@@ -18,29 +18,29 @@ source code repository logs.
1818

1919
This program and the accompanying materials are made available under the terms
2020
of the Eclipse Public License v. 2.0 which is available at
21-
https://www.eclipse.org/legal/epl-2.0. This Source Code may also be made
21+
<https://www.eclipse.org/legal/epl-2.0>. This Source Code may also be made
2222
available under the following Secondary Licenses when the conditions for such
2323
availability set forth in the Eclipse Public License v. 2.0 are satisfied:
2424
(secondary) GPL-2.0 with Classpath-exception-2.0 which is available at GNU
2525
General Public License v2.0 w/Classpath exception',
26-
'https://www.gnu.org/software/classpath/license.html.
26+
'<https://www.gnu.org/software/classpath/license.html>.
2727

2828
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
2929

3030
## Source Code
3131

3232
The project maintains the following source code repositories:
3333

34-
* https://github.com/eclipse-theia/theia
35-
* https://github.com/eclipse/theia-generator-plugin
36-
* https://github.com/eclipse/theia-yeoman-plugin
37-
* https://github.com/eclipse/theia-plugin-packager
38-
* https://github.com/eclipse-theia/theia-cpp-extensions
39-
* https://github.com/eclipse/theia-python-extension
40-
* https://github.com/eclipse/theia-java-extension
41-
* https://github.com/eclipse-theia/theia-example
42-
* https://github.com/eclipse-theia/cryptodetector
43-
* https://github.com/eclipse-theia/generator-theia-extension
34+
* <https://github.com/eclipse-theia/theia>
35+
* <https://github.com/eclipse/theia-generator-plugin>
36+
* <https://github.com/eclipse/theia-yeoman-plugin>
37+
* <https://github.com/eclipse/theia-plugin-packager>
38+
* <https://github.com/eclipse-theia/theia-cpp-extensions>
39+
* <https://github.com/eclipse/theia-python-extension>
40+
* <https://github.com/eclipse/theia-java-extension>
41+
* <https://github.com/eclipse-theia/theia-example>
42+
* <https://github.com/eclipse-theia/cryptodetector>
43+
* <https://github.com/eclipse-theia/generator-theia-extension>
4444

4545
## Third-party Content
4646

@@ -49,8 +49,8 @@ This project leverages the following third party content.
4949
chalk (2.4.1)
5050

5151
* License: MIT
52-
* Project: https://github.com/chalk/chalk
53-
* Source: https://github.com/chalk/chalk
52+
* Project: <https://github.com/chalk/chalk>
53+
* Source: <https://github.com/chalk/chalk>
5454

5555
code copied from project cortex-debug (0.1.21)
5656

@@ -63,8 +63,8 @@ Code copied from project Microsoft/vscode (1.31.0)
6363
Code copied from project Microsoft/vscode (1.32.3)
6464

6565
* License: MIT
66-
* Project: https://code.visualstudio.com/
67-
* Source: https://github.com/Microsoft/vscode
66+
* Project: <https://code.visualstudio.com/>
67+
* Source: <https://github.com/Microsoft/vscode>
6868

6969
Code copied from project Microsoft/vscode (1.32.3)
7070

@@ -108,7 +108,6 @@ code copied from project vscode (1.34.0)
108108

109109
code copied from project vscode (1.36.1)
110110

111-
112111
code copied from project vscode (1.36.1)
113112

114113
* License: MIT
@@ -178,14 +177,14 @@ [email protected] (2.0.14)
178177
AND BSD-3-Clause AND ISC AND X11 AND Public-Domain AND (GPL-2.0 OR MIT) AND
179178
Unlicense AND IJG AND ICU AND UNICODE-TOU AND NTP AND (MIT OR BSD-3-Clause)
180179
AND Libpng AND MPL-2.0 AND LGPL-2.1+
181-
* Project: https://github.com/electron/electron
182-
* Source: https://github.com/electron/electron/releases/tag/v2.0.14
180+
* Project: <https://github.com/electron/electron>
181+
* Source: <https://github.com/electron/electron/releases/tag/v2.0.14>
183182

184183
getmac (1.4.6)
185184

186185
* License: MIT
187-
* Project: https://github.com/bevry/getmac
188-
* Source: https://github.com/bevry/getmac
186+
* Project: <https://github.com/bevry/getmac>
187+
* Source: <https://github.com/bevry/getmac>
189188

190189
GH-3397: Implemented the HTTP-based authentication for Git in Electron. (n/a)
191190

@@ -194,15 +193,15 @@ GH-3397: Implemented the HTTP-based authentication for Git in Electron. (n/a)
194193
glob promise (3.4.0)
195194

196195
* License: ISC
197-
* Project: https://github.com/ahmadnassri/glob-promise
198-
* Source: https://github.com/ahmadnassri/glob-promise
196+
* Project: <https://github.com/ahmadnassri/glob-promise>
197+
* Source: <https://github.com/ahmadnassri/glob-promise>
199198

200199
Icon configure-inverse.svg (n/a)
201200

202201
* License: MIT
203-
* Project: https://github.com/Microsoft/vscode
202+
* Project: <https://github.com/Microsoft/vscode>
204203
* Source:
205-
https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/contrib/tasks/common/media/configure-inverse.svg#L1
204+
<https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/contrib/tasks/common/media/configure-inverse.svg#L1>
206205

207206
Icons copied from microsoft/vscode-icons version:
208207
b73945c70f1117c4e65939dd3e10bdd623cb4ef3 (n/a)
@@ -216,9 +215,9 @@ inversify (5.0.1)
216215
jschardet (1.6.0)
217216

218217
* License: (LGPL-2.1 OR LGPL-2.1+) AND (MIT OR GPL-2.0)
219-
* Project: https://www.npmjs.com/package/jschardet
218+
* Project: <https://www.npmjs.com/package/jschardet>
220219
* Source:
221-
https://github.com/aadsm/jschardet/tree/28152dd8db5904dc2cf9aa12ef4f8783f713e79a
220+
<https://github.com/aadsm/jschardet/tree/28152dd8db5904dc2cf9aa12ef4f8783f713e79a>
222221

223222
jschardet (2.1.1)
224223

@@ -243,20 +242,20 @@ long.js (3.2.0)
243242
micromatch (3.1.10)
244243

245244
* License: MIT
246-
* Project: https://github.com/micromatch/micromatch
247-
* Source: https://github.com/micromatch/micromatch
245+
* Project: <https://github.com/micromatch/micromatch>
246+
* Source: <https://github.com/micromatch/micromatch>
248247

249248
monaco-typescript (2.3.0)
250249

251250
* License: MIT
252-
* Project: https://github.com/Microsoft/monaco-typescript
253-
* Source: https://github.com/Microsoft/monaco-typescript.git
251+
* Project: <https://github.com/Microsoft/monaco-typescript>
252+
* Source: <https://github.com/Microsoft/monaco-typescript.git>
254253

255254
native-keymap (1.2.5)
256255

257256
* License: BSD-3-Clause AND MIT
258-
* Project: https://github.com/Microsoft/node-native-keymap
259-
* Source: https://github.com/Microsoft/node-native-keymap
257+
* Project: <https://github.com/Microsoft/node-native-keymap>
258+
* Source: <https://github.com/Microsoft/node-native-keymap>
260259

261260
node-oniguruma (n/a)
262261

@@ -272,24 +271,23 @@ node.js dependencies for Theia (n/a)
272271

273272
Preference code copied from vscode (n/a)
274273

275-
276274
ps-list (5.0.1)
277275

278276
* License: MIT
279-
* Project: https://github.com/sindresorhus/ps-list
280-
* Source: https://github.com/sindresorhus/ps-list
277+
* Project: <https://github.com/sindresorhus/ps-list>
278+
* Source: <https://github.com/sindresorhus/ps-list>
281279

282280
react-perfect-scrollbar:1.5.3 (1.5.3)
283281

284282
* License: MIT
285-
* Project: https://github.com/goldenyz/react-perfect-scrollbar
286-
* Source: https://github.com/goldenyz/react-perfect-scrollbar
283+
* Project: <https://github.com/goldenyz/react-perfect-scrollbar>
284+
* Source: <https://github.com/goldenyz/react-perfect-scrollbar>
287285

288286
read-pkg (4.0.1)
289287

290288
* License: MIT
291-
* Project: https://github.com/sindresorhus/read-pkg
292-
* Source: https://github.com/sindresorhus/read-pkg
289+
* Project: <https://github.com/sindresorhus/read-pkg>
290+
* Source: <https://github.com/sindresorhus/read-pkg>
293291

294292
regular expressions and helper function copied from microsoft/vscode (1.33.1)
295293

@@ -298,8 +296,8 @@ regular expressions and helper function copied from microsoft/vscode (1.33.1)
298296
requestretry (3.1.0)
299297

300298
* License: MIT
301-
* Project: https://github.com/FGRibreau/node-request-retry
302-
* Source: https://github.com/FGRibreau/node-request-retry
299+
* Project: <https://github.com/FGRibreau/node-request-retry>
300+
* Source: <https://github.com/FGRibreau/node-request-retry>
303301

304302
rimraf (2.6.2)
305303

@@ -326,8 +324,8 @@ theia-cpp-extension npm node (n/a)
326324
tslint (5.10.0)
327325

328326
* License: Apache-2.0 AND MIT
329-
* Project: http://palantir.github.io/tslint/
330-
* Source: https://github.com/palantir/tslint
327+
* Project: <http://palantir.github.io/tslint/>
328+
* Source: <https://github.com/palantir/tslint>
331329

332330
typefox/monaco-language-client (0.5.0)
333331

@@ -336,16 +334,16 @@ typefox/monaco-language-client (0.5.0)
336334
typescript-formatter (7.2.2)
337335

338336
* License: MIT
339-
* Project: https://github.com/vvakame/typescript-formatter
340-
* Source: https://github.com/vvakame/typescript-formatter
337+
* Project: <https://github.com/vvakame/typescript-formatter>
338+
* Source: <https://github.com/vvakame/typescript-formatter>
341339

342340
VS Code (1.33.0)
343341

344342
* License: MIT
345343

346344
VS Code built-in extensions (1.30.1)
347345

348-
* License: Apache-2.0 AND MIT AND Unicode-DFS-2016 AND CC-BY-4.0 AND W3C
346+
* License: Apache-2.0 AND MIT AND Unicode-DFS-2016 AND CC-BY-4.0 AND W3C
349347

350348
vscode (1.26.0)
351349

@@ -382,14 +380,14 @@ vscode-java-debug (0.15.0)
382380
webdriverio (n/a)
383381

384382
* License: MIT
385-
* Project: http://webdriver.io/
386-
* Source: https://github.com/webdriverio/webdriverio.git
383+
* Project: <http://webdriver.io/>
384+
* Source: <https://github.com/webdriverio/webdriverio.git>
387385

388386
when (3.7.8)
389387

390388
* License: MIT
391-
* Project: https://github.com/cujojs/when
392-
* Source: https://github.com/cujojs/when
389+
* Project: <https://github.com/cujojs/when>
390+
* Source: <https://github.com/cujojs/when>
393391

394392
wjordan/browser-path SHA6719d19077b1454bff8b802f9be79cb1b69ebe7e (n/a)
395393

@@ -406,8 +404,8 @@ xterm-addon-search (0.5.0)
406404
xterm.js (3.9.1)
407405

408406
* License: MIT
409-
* Project: https://xtermjs.org/
410-
* Source: https://github.com/xtermjs/xterm.js
407+
* Project: <https://xtermjs.org/>
408+
* Source: <https://github.com/xtermjs/xterm.js>
411409

412410
xterm.js (4.4)
413411

@@ -416,32 +414,32 @@ xterm.js (4.4)
416414
yargs (12.0.1)
417415

418416
* License: MIT
419-
* Project: http://yargs.js.org/
420-
* Source: https://github.com/yargs/yargs
417+
* Project: <http://yargs.js.org/>
418+
* Source: <https://github.com/yargs/yargs>
421419

422420
yeoman environment (2.3.0)
423421

424422
* License: BSD-2-Clause AND BSD-3-Clause
425-
* Project: https://github.com/yeoman/environment
426-
* Source: https://github.com/yeoman/environment
423+
* Project: <https://github.com/yeoman/environment>
424+
* Source: <https://github.com/yeoman/environment>
427425

428426
yeoman generator (3.0.0)
429427

430428
* License: BSD-2-Clause AND BSD-3-Clause
431-
* Project: http://yeoman.io
432-
* Source: https://github.com/yeoman/generator
429+
* Project: <http://yeoman.io>
430+
* Source: <https://github.com/yeoman/generator>
433431

434432
yeoman-generator (2.0)
435433

436434
* License: BSD-2-Clause
437-
* Project: http://yeoman.io/
438-
* Source: https://github.com/yeoman/generator
435+
* Project: <http://yeoman.io/>
436+
* Source: <https://github.com/yeoman/generator>
439437

440438
yosay (2.0.2)
441439

442440
* License: BSD-2-Clause
443-
* Project: https://github.com/yeoman/yosay
444-
* Source: https://github.com/yeoman/yosay
441+
* Project: <https://github.com/yeoman/yosay>
442+
* Source: <https://github.com/yeoman/yosay>
445443

446444
## Cryptography
447445

@@ -470,4 +468,4 @@ licensing fees.
470468
We strongly recommend downstream consumers verify the type of FFmpeg support
471469
configured and modify as required. More information on instructions to verify
472470
can be found here
473-
https://electronjs.org/docs/development/upgrading-chromium#verify-ffmpeg-support
471+
<https://electronjs.org/docs/development/upgrading-chromium#verify-ffmpeg-support>

0 commit comments

Comments
 (0)