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

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

@ -133,7 +133,7 @@ include ../../../_includes/_util-fns
:markdown
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
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
a separator that consists of `/* more code here */` in the output file.
@ -213,7 +213,7 @@ include ../../../_includes/_util-fns
#### Example
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
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.
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
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.
- *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.
- *stylePattern:* (*optional) allows additional styling via regular expression ( described above).
- *stylePattern:* (optional) allows additional styling via regular expression ( described above).
#### Example:
@ -297,6 +297,7 @@ include ../../../_includes/_util-fns
As well as styling across multiple lines.
code-example(format="linenums" language="js").
- var styles = { pnk: /(^.*dependencies[\s\S]* \})/gm };
+makeJson('styleguide/package.json', {paths: 'name, version, dependencies '}, "Foo", styles )
- var styles = { pnk: /(^.*dependencies[\s\S]* \})/gm };
@ -312,8 +313,8 @@ include ../../../_includes/_util-fns
This style has several named attributes
#### code-example attributes
- *name:" Name displayed in Tab (required for tabs)
- *language* javascript, html, etc.
- *name:* Name displayed in Tab (required for tabs)
- *language:* javascript, html, etc.
- *escape:* html (escapes html, woot!)
- *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>)
code-example(language="html" format="linenums").
h1 Title
p This is some copy...
&lt;h1&gt;Title&lt;/h1&gt;
&lt;p&gt;This is some copy...&lt;/p&gt;
.l-sub-section
h3 Code Highlighting
p.
There are three types of highlights avialable
There are three types of highlights available
<strong>Outlined</strong>, <strong>Pink</strong>, and
<strong>Black</strong>. You can see examples below and
the class names needed for each type.