Skip to content

Commit db1fe3d

Browse files
committed
replace index.src mentions with index.html.src
1 parent cfdf8fd commit db1fe3d

File tree

7 files changed

+9
-9
lines changed

7 files changed

+9
-9
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To clear some confusion around Living Style Guide Platforms comparison, let us d
3333

3434
### CSS Documentation parser
3535

36-
Engine is based on gathering special documentation templates (`index.src`, `readme.md` and others), where you leave your HTML examples, template includes and description. All Specs are located in `sourcejs/user/specs` folder, and could contain any catalogue structure, with focus on component folders.
36+
Engine is based on gathering special documentation templates (`index.src.html`, `readme.md` and others), where you leave your HTML examples, template includes and description. All Specs are located in `sourcejs/user/specs` folder, and could contain any catalogue structure, with focus on component folders.
3737

3838
**But** you can use official SourceJS plugin based on DSS, CSS Documentation parser - https://github.com/sourcejs/sourcejs-contrib-dss.
3939

core/lib/specUtils.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ var parseData = require(path.join(global.pathToApp, 'core/lib/parseData'));
88
/**
99
* Parse clean path to spec from URL
1010
*
11-
* @param {String} urlPath - raw url ("/base/spec/index.src")
11+
* @param {String} urlPath - raw url ("/base/spec/index.src.html")
1212
*
1313
* @returns {Object} output
1414
* @returns {String} output.ext - file extension, if exists

docs/api/plugins/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Most common use cases of middleware in SourceJS in modification of Spec file con
114114

115115
Middlewares are automatically loaded after installation, and are evaluated on each request before `sourcejs/core/middleware/wrap.js` and `sourcejs/core/middleware/send.js`.
116116

117-
`wrap.js` is wrapping `index.src` contents in a pre-defined a view template from `sourcejs/core/views` or user custom path `sourcejs/user/core/views` using [EJS](http://www.embeddedjs.com/).
117+
`wrap.js` is wrapping spec page (`index.src.html`, `index.md` and etc) contents in a pre-defined a view template from `sourcejs/core/views` or user custom path `sourcejs/user/core/views` using [EJS](http://www.embeddedjs.com/).
118118

119119
`send.js` is used in case when we modify Spec contents, as we do with `*.src.html` and all other middlewares. Modified Spec content is passed through `req.specData.renderedHtml` object, which each middleware can modify during the request handling process and which then is sent to the client's browser.
120120

docs/markdown/readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ SourceJS supports markdown as pure `.md` files and renders it in any other exten
44

55
## Basics
66

7-
Engine treats `index.md` and `readme.md` as main Spec files. Readme file is taken with lowest priority after `index.src`, `index.md` and others.
7+
Engine treats `index.md` and `readme.md` as main Spec files. Readme file is taken with lowest priority after `index.src.html`, `index.md` and others.
88

9-
In case if Spec folder contains `index.src` and `index.md`, first one will have higher priority.
9+
In case if Spec folder contains `index.src.html` and `index.md`, first one will have higher priority.
1010

1111
## Markup examples
1212

docs/spec/index.src.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ <h2>Spec Page Markup</h2>
141141

142142
<p>This styling <strong>is not applied inside example blocks</strong>.</p>
143143

144-
<p>From 0.5.0 SourceJS fully supports Markdown based Specs as well. You can use <code>&lt;markdown&gt;</code> tag in any Spec templates including <code>index.src</code>, or just use <code>readme.md</code> templates instead.</p>
144+
<p>From 0.5.0 SourceJS fully supports Markdown based Specs as well. You can use <code>&lt;markdown&gt;</code> tag in any Spec templates including <code>index.src.html</code>, or just use <code>readme.md</code> templates instead.</p>
145145

146146
<p><a href="/docs/markdown">Read more about markdown support</a></p>
147147

@@ -151,7 +151,7 @@ <h2>Spec Page Markup</h2>
151151
<h2>Source code</h2>
152152

153153
<p>
154-
This spec uses <code>index.src</code> template, view it's <a href="index.src">source</a>.
154+
This spec uses <code>index.src.html</code> template, view it's <a href="index.src.html">source</a>.
155155
</p>
156156

157157
</section>

docs/starting/index.src.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ <h2>Spec Section Heading</h2>
2323
</div>
2424

2525
<p>
26-
This spec uses <code>index.src</code> template, view it's <a href="index.src">source</a>.
26+
This spec uses <code>index.src.html</code> template, view it's <a href="index.src.html">source</a>.
2727
</p>
2828

2929
</section>

docs/test-specs/styles/index.src.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ <h2>Spec Page Markup</h2>
123123
<h2>Source code</h2>
124124

125125
<p>
126-
This spec uses <code>index.src</code> template, view it's <a href="index.src">source</a>.
126+
This spec uses <code>index.src.html</code> template, view it's <a href="index.src.html">source</a>.
127127
</p>
128128

129129
</section>

0 commit comments

Comments
 (0)