Skip to content

Commit b901e4b

Browse files
thomasslobodaxbrainnfroidure
authored andcommitted
feat(jsarch.js): switch from HTML comment to most compatible Markdown version
1 parent c387c91 commit b901e4b

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

ARCHITECTURE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
<!--
2-
# This file is automatically generated by the `jsarch`
3-
# module. Do not change it elsewhere, changes would
4-
# be overriden.
5-
-->
1+
[//]: # ( )
2+
[//]: # (This file is automatically generated by the `jsarch`)
3+
[//]: # (module. Do not change it elsewhere, changes would)
4+
[//]: # (be overriden.)
5+
[//]: # ( )
66
# Architecture Notes
77

88

src/jsarch.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ types.finalize();
3232
const ARCHITECTURE_NOTE_REGEXP = /^\s*Architecture Note #((?:\d+(?:\.(?=\d)|)){1,8}):\s+([^\r\n$]*)/;
3333
const SHEBANG_REGEXP = /#! (\/\w+)+ node/;
3434
const EOL_REGEXP = /\n/g;
35-
const JSARCH_PREFIX = `<!--
36-
# This file is automatically generated by the \`jsarch\`
37-
# module. Do not change it elsewhere, changes would
38-
# be overriden.
39-
-->
35+
const JSARCH_PREFIX = `[//]: # ( )
36+
[//]: # (This file is automatically generated by the \`jsarch\`)
37+
[//]: # (module. Do not change it elsewhere, changes would)
38+
[//]: # (be overriden.)
39+
[//]: # ( )
4040
`;
4141

4242
/* Architecture Note #1.3: Title level

src/jsarch.mocha.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ const assert = require('assert');
44
const sinon = require('sinon');
55
const Knifecycle = require('knifecycle').default;
66
const initJSArch = require('./jsarch');
7-
const JSARCH_PREFIX = `<!--
8-
# This file is automatically generated by the \`jsarch\`
9-
# module. Do not change it elsewhere, changes would
10-
# be overriden.
11-
-->
7+
const JSARCH_PREFIX = `[//]: # ( )
8+
[//]: # (This file is automatically generated by the \`jsarch\`)
9+
[//]: # (module. Do not change it elsewhere, changes would)
10+
[//]: # (be overriden.)
11+
[//]: # ( )
1212
`;
1313

1414
describe('jsArch service', () => {

0 commit comments

Comments
 (0)