honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(styleguide): fix minor typos

This commit is contained in:
Filipe Silva 2015-11-04 21:59:13 +00:00 committed by Ward Bell
parent 9e088bfe73
commit 7676a5c101
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
public/docs/_includes/styleguide/_code-examples.jade
View File

@ -133,7 +133,7 @@ include ../../../_includes/_util-fns
:markdown :markdown
Multiple `#docregion` tags may be defined on a single line as shown below. In addition, anytime a file contains multiple Multiple `#docregion` tags may be defined on a single line as shown below. In addition, anytime a file contains multiple
`#docregion` tags with the same name they will automatically be combined. Each of the individually tagged sections of the combined document `#docregion` tags with the same name they will automatically be combined. Each of the individually tagged sections of the combined document
will be separated from one another by a comment consisting or '. . .'. This default separator, known will be separated from one another by a comment consisting of '. . .'. This default separator, known
as 'plaster' can be overriden anywhere within the affected file via a `#docplaster` comment as shown below. This example creates as 'plaster' can be overriden anywhere within the affected file via a `#docplaster` comment as shown below. This example creates
a separator that consists of `/* more code here */` in the output file. a separator that consists of `/* more code here */` in the output file.
@ -213,7 +213,7 @@ include ../../../_includes/_util-fns
#### Example #### Example
code-example(format="linenums" language="js" escape="none"). code-example(format="linenums" language="js" escape="none").
+makeExample('styleguide/js/index.html', null, 'index.html', {pnk: /script (src=.*&ampquot)/g}) +makeExample('styleguide/js/index.html', null, 'index.html', {pnk: /script (src=.*&ampquot;)/g})
:markdown :markdown
Which will mark all of the quoted contents of each `script` tag within the index.html file in pink. Which will mark all of the quoted contents of each `script` tag within the index.html file in pink.
@ -222,7 +222,7 @@ include ../../../_includes/_util-fns
Note that expression replacement occurs AFTER the fragment has been included and html escaped. Note that expression replacement occurs AFTER the fragment has been included and html escaped.
This means that your regular expression must use escaped html text; i.e. the '&ampquot' in the regex above. This means that your regular expression must use escaped html text; i.e. the '&ampquot' in the regex above.
+makeExample('styleguide/js/index.html', null, 'index.html', {pnk: /script (src=.*&quot)/g}) +makeExample('styleguide/js/index.html', null, 'index.html', {pnk: /script (src=.*")/g})
:markdown :markdown
A more complicated example might be: A more complicated example might be:
@ -268,7 +268,7 @@ include ../../../_includes/_util-fns
- *paths:* a comma delimited list of property paths for those elements to be selected. - *paths:* a comma delimited list of property paths for those elements to be selected.
- *space:* (optional default=" " [2 spaces]) a String or Number object that's used to insert white space into the output JSON - *space:* (optional default=" " [2 spaces]) a String or Number object that's used to insert white space into the output JSON
- *title:* (optional) title displayed above the included text. - *title:* (optional) title displayed above the included text.
- *stylePattern:* (*optional) allows additional styling via regular expression ( described above). - *stylePattern:* (optional) allows additional styling via regular expression ( described above).
#### Example: #### Example:
@ -297,6 +297,7 @@ include ../../../_includes/_util-fns
As well as styling across multiple lines. As well as styling across multiple lines.
code-example(format="linenums" language="js"). code-example(format="linenums" language="js").
- var styles = { pnk: /(^.*dependencies[\s\S]* \})/gm };
+makeJson('styleguide/package.json', {paths: 'name, version, dependencies '}, "Foo", styles ) +makeJson('styleguide/package.json', {paths: 'name, version, dependencies '}, "Foo", styles )
- var styles = { pnk: /(^.*dependencies[\s\S]* \})/gm }; - var styles = { pnk: /(^.*dependencies[\s\S]* \})/gm };
@ -312,8 +313,8 @@ include ../../../_includes/_util-fns
This style has several named attributes This style has several named attributes
#### code-example attributes #### code-example attributes
- *name:" Name displayed in Tab (required for tabs) - *name:* Name displayed in Tab (required for tabs)
- *language* javascript, html, etc. - *language:* javascript, html, etc.
- *escape:* html (escapes html, woot!) - *escape:* html (escapes html, woot!)
- *format:* linenums (or linenums:4 specify starting line) - *format:* linenums (or linenums:4 specify starting line)
@ -341,13 +342,13 @@ include ../../../_includes/_util-fns
your desired language (example below uses <strong>.lang-html</strong>) your desired language (example below uses <strong>.lang-html</strong>)
code-example(language="html" format="linenums"). code-example(language="html" format="linenums").
h1 Title &lt;h1&gt;Title&lt;/h1&gt;
p This is some copy... &lt;p&gt;This is some copy...&lt;/p&gt;
.l-sub-section .l-sub-section
h3 Code Highlighting h3 Code Highlighting
p. p.
There are three types of highlights avialable There are three types of highlights available
<strong>Outlined</strong>, <strong>Pink</strong>, and <strong>Outlined</strong>, <strong>Pink</strong>, and
<strong>Black</strong>. You can see examples below and <strong>Black</strong>. You can see examples below and
the class names needed for each type. the class names needed for each type.
@ -488,4 +489,4 @@ include ../../../_includes/_util-fns
* {@linkDevGuide /js/latest/guide/gettingStarted title='Getting Started' } * {@linkDevGuide /js/latest/guide/gettingStarted title='Getting Started' }
* Or... an attempt will be made to infer the title if it is omitted. * Or... an attempt will be made to infer the title if it is omitted.
* {@linkDevGuide /js/latest/guide/gettingStarted } * {@linkDevGuide /js/latest/guide/gettingStarted }
**/ **/