diff --git a/templates/.stylelintrc.json b/templates/.stylelintrc.json index a1b08ce2855..856d46a1e01 100644 --- a/templates/.stylelintrc.json +++ b/templates/.stylelintrc.json @@ -5,6 +5,11 @@ "**/docfx.scss" ], "rules": { - "selector-class-pattern": null + "selector-class-pattern": null, + "font-family-no-missing-generic-family-keyword": [ true, { + "ignoreFontFamilies": [ + "bootstrap-icons" + ] + }] } } diff --git a/templates/modern/layout/_master.tmpl b/templates/modern/layout/_master.tmpl index 222fd80db28..1cae31d2541 100644 --- a/templates/modern/layout/_master.tmpl +++ b/templates/modern/layout/_master.tmpl @@ -23,7 +23,6 @@ {{#_noindex}}{{/_noindex}} {{#_enableSearch}}{{/_enableSearch}} - {{#_enableNewTab}}{{/_enableNewTab}} {{#docurl}}{{/docurl}} {{#yamlmime}}{{/yamlmime}} {{/redirect_url}} diff --git a/templates/modern/src/docfx.scss b/templates/modern/src/docfx.scss index 58ca6336902..77de2debfaa 100644 --- a/templates/modern/src/docfx.scss +++ b/templates/modern/src/docfx.scss @@ -81,7 +81,7 @@ article { } @mixin adjust-icon { - font-family: bootstrap-icons, sans-serif; + font-family: bootstrap-icons; position: relative; margin-right: 0.5em; top: 0.2em; diff --git a/templates/modern/src/markdown.scss b/templates/modern/src/markdown.scss index 483e867e338..dc5877ada9f 100644 --- a/templates/modern/src/markdown.scss +++ b/templates/modern/src/markdown.scss @@ -3,6 +3,15 @@ * Licensed under the MIT License. See License.txt in the project root for license information. */ +/* External link icon */ +a.external[href]::after { + font-family: bootstrap-icons; + content: "\F1C5"; + font-size: .6rem; + margin: 0 .2em; + display: inline-block; +} + /* Alerts */ .alert h5 { text-transform: uppercase; diff --git a/templates/modern/src/markdown.ts b/templates/modern/src/markdown.ts index fb79c88523e..a95e9bfb76d 100644 --- a/templates/modern/src/markdown.ts +++ b/templates/modern/src/markdown.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -import { breakWord, meta } from './helper' +import { breakWord } from './helper' import AnchorJs from 'anchor-js' import { html, render } from 'lit-html' @@ -67,8 +67,8 @@ function renderClickableImage() { function shouldMakeClickable(): boolean { return img.naturalWidth > MIN_CLICKABLE_IMAGE_SIZE && - img.naturalHeight > MIN_CLICKABLE_IMAGE_SIZE && - !imageLinks.includes(img) + img.naturalHeight > MIN_CLICKABLE_IMAGE_SIZE && + !imageLinks.includes(img) } }) } @@ -100,15 +100,13 @@ function renderAlerts() { * Open external links to different host in a new window. */ function renderLinks() { - if (meta('docfx:newtab') === 'true') { - const links = document.links - for (let i = 0; i < links.length; i++) { - const link = links.item(i) - if (link.hostname !== window.location.hostname) { - link.target = '_blank' - } + document.querySelectorAll('article a[href]').forEach(a => { + if (a.hostname !== window.location.hostname && a.innerText.trim() !== '') { + a.target = '_blank' + a.rel = 'noopener noreferrer nofollow' + a.classList.add('external') } - } + }) } /** diff --git a/templates/modern/src/toc.scss b/templates/modern/src/toc.scss index 48567f896ba..ca41bb7b0a3 100644 --- a/templates/modern/src/toc.scss +++ b/templates/modern/src/toc.scss @@ -44,7 +44,7 @@ $expand-stub-width: 1.2rem; display: inline-block; width: $expand-stub-width; cursor: pointer; - font-family: bootstrap-icons, sans-serif; + font-family: bootstrap-icons; content: "\F285"; position: absolute; margin-left: -$expand-stub-width; diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.Cat-2.html-q-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.Cat-2.html-q-cat.verified.png index 4c77c67af69..e96d2ef46e9 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.Cat-2.html-q-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.Cat-2.html-q-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:062242ba00c0b09cf803edf7cc118a8a9b840180ec54bd329460a9122f71becc -size 113952 +oid sha256:c5bf910e77266cf41be45a2f9bee5cbd85254c74f88336ccab3c411697b1336b +size 114290 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/index.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/index.html.verified.png index a636ad03bd1..315f72848c7 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/index.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/index.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ef1a26c349c2a966f5b3b1f76037ebadf4ce3ba7900ee1f765682db45edbaec8 -size 125049 +oid sha256:3ab08f6ace1759d72a0a24d967e13b1c59ef358ae09d6a1fcf4ba81c6db4b8ef +size 126156 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/restapi-petstore.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/restapi-petstore.html.verified.png index 2f4d9546252..f79254850bf 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/restapi-petstore.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/restapi-petstore.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aac13aa85516388c026470745cd5605c44b79a4fcb0c12f2e43bcdfddfdb5253 -size 64670 +oid sha256:4200314540ac0e7e7e67265af746c80ef112fed9701de00d44e851aefc75f0aa +size 64835 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.Cat-2.html-q-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.Cat-2.html-q-cat.verified.png index 50ab5ef796c..ca536eaeebc 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.Cat-2.html-q-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.Cat-2.html-q-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:75b2150835e7d069750445a75c57de64d5447a7f29290cc3aeedca0f73228842 -size 1030158 +oid sha256:ac5148d1f2c5ee01f39f097315062061651086b40d80bbe58ec9816bf62efc45 +size 1035138 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/articles-csharp_coding_standards.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/articles-csharp_coding_standards.html.verified.png index c4c7433d4d1..19547806097 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/articles-csharp_coding_standards.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/articles-csharp_coding_standards.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1875f6fbf2d53f29a9b50f848230d9ad255faa9401625cb86b01ef56ac1b34d1 -size 1007200 +oid sha256:4568e1d2ec684c7c34da31a477b4f5d1d88301546adab5db2dc49295f89b48d9 +size 1009114 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/index.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/index.html.verified.png index 40195155991..e6d8579a670 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/index.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/index.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7d807e8814ee2e59667cfa89a929304f3deee968509007795f69e012bcbbe1bc -size 181165 +oid sha256:609223cafe7288b18607db8035e2659b20a55bbe39d4906c6835f105c0441317 +size 181295 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/restapi-petstore.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/restapi-petstore.html.verified.png index 477880f16cd..0a038306375 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/restapi-petstore.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/restapi-petstore.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:611960a8f189591c005ea544ae056fa69e4c7abba20847bbd85f95d750a435c6 -size 1181152 +oid sha256:cab1915014c6ca4ad6452a1a3e6f1bcadabe3b27761f5041a229369291534c14 +size 1184715 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.Cat-2.html-q-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.Cat-2.html-q-cat.verified.png index 22a43fd5dae..6fce2da096d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.Cat-2.html-q-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.Cat-2.html-q-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:52158619f1b9702ff38b69e29fbbf7612bf1e11f274295154c97095a22f88b71 -size 804851 +oid sha256:ee060e807a73c77559f106e40837224286ee8302120afb8e4bb500890d9f980e +size 812541 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/articles-csharp_coding_standards.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/articles-csharp_coding_standards.html.verified.png index ed8b6d7593f..e8ab8b7c111 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/articles-csharp_coding_standards.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/articles-csharp_coding_standards.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7e1374eb59996a35731c627057f01f29c379c740126e57ada02b0afbe5792a66 -size 1052917 +oid sha256:a665064af56e9c83f9d657a406a33c1481c74e6d0c19e02cbe198250f571036a +size 1053215 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.png index 79796f49a16..33864522d39 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:83f5c0a79dd87b3772fc8143fb8f6a6b1bb51d3aa195d742a564b3b9106bd4e5 -size 803340 +oid sha256:d2e6f7ee59eb5d487a8217c2be2db599b33913d1e2c5823ac53343d848bb59f5 +size 804023 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/index.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/index.html.verified.png index 80abd5c733d..af6f23f5440 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/index.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/index.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1f5643a24f21a57f29b986e54c609fb6a327b31d97913024e36c269bf967fa5a -size 173275 +oid sha256:d3dd5ca6855832c01547e93c99647ae5eeaba3e02881876410d36374d9264342 +size 174453 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.Cat-2.html-q-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.Cat-2.html-q-cat.verified.png index 310507fe89d..b8c6ddc9b31 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.Cat-2.html-q-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.Cat-2.html-q-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4e599ab2ea8f3b1d0d06b1c35eabc8ceee5a556e8dd3b26043a2e363cd00ef89 -size 100374 +oid sha256:b8c34386a016c28d1be9004bff6c4a3cf002ccbdcb0ab3730a8c0a786048e7c9 +size 100559 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/index.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/index.html.verified.png index 7036ba425fe..3eeafa9e12c 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/index.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/index.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ceb4be690a2c88f26f5a65c2e45bb0476b884b4ddb21ebbe43880868537bccac -size 112963 +oid sha256:0633bbf03f39a1a7317ec49e8b7d6e67b6c37d6db2295f1684c2cdbc4cea036c +size 113957 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html index 1aad574f53e..b3e5ea0f70e 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html @@ -13,7 +13,6 @@ - @@ -235,7 +234,7 @@

Class C

The extension method of this class can refer to ICatExtension class

-

This is a class talking about CAT.

+

This is a class talking about CAT.

NOTE This is a CAT class

@@ -244,7 +243,7 @@

Class C

Inheritance
-
object
+
object
Cat<T, K>
@@ -255,22 +254,22 @@
Implements
Inherited Members
- object.Equals(object, object) + object.Equals(object, object)
- object.GetHashCode() + object.GetHashCode()
- object.GetType() + object.GetType()
- object.MemberwiseClone() + object.MemberwiseClone()
- object.ReferenceEquals(object, object) + object.ReferenceEquals(object, object)
- object.ToString() + object.ToString()
Namespace: CatLibrary
@@ -318,10 +317,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

Cat()

@@ -334,10 +333,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

Cat(T)

@@ -368,10 +367,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Cat(string, out int, string, bool)

@@ -393,25 +392,25 @@
Parameters
- string + string nickName

it's string type.

- int + int age

It's an out and ref parameter.

- string + string realName

It's an out paramter.

- bool + bool isHealthy

It's an in parameter.

@@ -422,10 +421,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

isHealthy

Field with attribute.

@@ -447,7 +446,7 @@
Field Value
- bool + bool @@ -456,10 +455,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Age

@@ -480,17 +479,17 @@
Property Value
- int + int
| - Improve this Doc + Improve this Doc - View Source + View Source

this[string]

@@ -512,7 +511,7 @@
Parameters
- string + string a

Cat's name.

@@ -529,7 +528,7 @@
Property Value
- int + int

Cat's number.

@@ -537,10 +536,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -561,7 +560,7 @@
Property Value
- string + string @@ -570,10 +569,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

Override CalculateFood Name

@@ -597,7 +596,7 @@
Parameters
- DateTime + DateTime date

This is overridden description for a parameter. id must be specified.

@@ -614,7 +613,7 @@
Returns
- Dictionary<string, List<int>> + Dictionary<string, List<int>>

It's overridden description for return. type must be specified.

@@ -630,7 +629,7 @@
Exceptions
- ArgumentException + ArgumentException

This is an overridden argument exception. you can add additional exception by adding different exception type.

@@ -638,10 +637,10 @@
Exceptions
| - Improve this Doc + Improve this Doc - View Source + View Source

Equals(object)

@@ -663,7 +662,7 @@
Parameters
- object + object obj

Can pass any class type.

@@ -680,20 +679,20 @@
Returns
- bool + bool

The return value tell you whehter the compare operation is successful.

Overrides
-
Object.Equals(Object)
+
Object.Equals(Object)
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTailLength(int*, params object[])

@@ -716,13 +715,13 @@
Parameters
- int* + int* catName

Thie represent for cat name length.

- object[] + object[] parameters

Optional parameters.

@@ -739,7 +738,7 @@
Returns
- long + long

Return cat tail's length.

@@ -747,10 +746,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

Jump(T, K, ref bool)

@@ -785,7 +784,7 @@
Parameters
- bool + bool cheat

Hint whether this cat has cheat mode.

@@ -802,7 +801,7 @@
Exceptions
- ArgumentException + ArgumentException

This is an argument exception

@@ -812,10 +811,10 @@

Events

| - Improve this Doc + Improve this Doc - View Source + View Source

ownEat

Eat event of this cat

@@ -835,7 +834,7 @@
Event Type
- EventHandler + EventHandler @@ -844,10 +843,10 @@

Operators

| - Improve this Doc + Improve this Doc - View Source + View Source

operator +(Cat<T, K>, int)

@@ -875,7 +874,7 @@
Parameters
- int + int rsr
@@ -892,7 +891,7 @@
Returns
- int + int

Result with int type.

@@ -900,10 +899,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

explicit operator Tom(Cat<T, K>)

@@ -951,10 +950,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

operator -(Cat<T, K>, int)

@@ -981,7 +980,7 @@
Parameters
- int + int rsr @@ -997,7 +996,7 @@
Returns
- int + int diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html index ad2f97871c7..8262d546cc2 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html @@ -14,7 +14,6 @@ - diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html index bc550428d65..7d4d079137d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html @@ -14,7 +14,6 @@ - diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html index 3300f4f0d3e..14681350acf 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html @@ -11,7 +11,6 @@ - @@ -103,14 +102,14 @@

IntroductionPurpose

The aim of this section is to define a set of C# coding standards to be used by CAPS build team to guarantee maximum legibility, reliability, re-usability and homogeneity of our code. Each section is marked Mandatory or Recommended. Mandatory sections, will be enforced during code reviews as well as tools like StyleCop and FxCop, and code will not be considered complete until it is compliant.

Scope

-

This section contains general C# coding standards which can be applied to any type of application developed in C#, based on Framework Design Guidelines.

+

This section contains general C# coding standards which can be applied to any type of application developed in C#, based on Framework Design Guidelines.

It does not pretend to be a tutorial on C#. It only includes a set of limitations and recommendations focused on clarifying the development.

Tools

Highlights of Coding Standards

This section is not intended to give a summary of all the coding standards that enabled by our customized StyleCop, but to give a highlight of some rules one will possibly meet in daily coding life. It also provides some recommended however not mandatory(which means not enabled in StyleCop) coding standards.

@@ -160,7 +159,7 @@

Naming (Mandatory)private const string MetadataName = "MetadataName"; -

  • DO NOT capitalize each word in so-called closed-form compound words.

    +

  • DO NOT capitalize each word in so-called closed-form compound words.

  • DO have "Async" explicitly in the Async method name to notice people how to use it properly

    • diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html index d75098edf3f..8bbce9822eb 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html @@ -11,7 +11,6 @@ - @@ -94,7 +93,7 @@

    Table of Contents

    Markdown

    -

    Markdown is a lightweight markup language with plain text formatting syntax. Docfx supports CommonMark compliant Markdown parsed through the Markdig parsing engine.

    +

    Markdown is a lightweight markup language with plain text formatting syntax. Docfx supports CommonMark compliant Markdown parsed through the Markdig parsing engine.

    Markdown Extensions

    Docfx supports additional markdown syntax that provide richer content. These syntax are specific to docfx and won't be rendered elsewhere like GitHub.

    To use a custom markdown extension:

    diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html index 06bd9a36bd6..cb279ac3caf 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html @@ -11,7 +11,6 @@ - @@ -92,21 +91,21 @@

    docfx-seed

    Description

    This is a sample docfx documentation project. It contains .NET source code and markdown files. docfx.json is the configuration file for running docfx. -docfx will generate a static website as similar to http://docascode.github.io/docfx-seed.

    +docfx will generate a static website as similar to http://docascode.github.io/docfx-seed.

    How to run

    Under Windows

    Cross platform and use dnx

    -

    As a prerequisite, you will need to install DNVM and DNX. +

    As a prerequisite, you will need to install DNVM and DNX. ###Quick Start

    Further information about docfx

    -

    docfx is a tool to generate documentation towards .NET source code and markdown files. Please refer to docfx to get start. The docfx website itself is generated by docfx!

    +

    docfx is a tool to generate documentation towards .NET source code and markdown files. Please refer to docfx to get start. The docfx website itself is generated by docfx!

    diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html index 549b8c78ff0..17a80bd68c7 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html @@ -11,7 +11,6 @@ - @@ -88,10 +87,10 @@

    pet | - Improve this Doc + Improve this Doc - View Source + View Source

    addPet

    Add a new pet to the store

    @@ -149,10 +148,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    updatePet

    Update an existing pet

    @@ -219,10 +218,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    findPetsByStatus

    Finds Pets by status

    @@ -284,10 +283,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    findPetsByTags

    Finds Pets by tags

    @@ -349,10 +348,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    deletePet

    Deletes a pet

    @@ -418,10 +417,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    getPetById

    Find pet by ID

    @@ -490,10 +489,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    updatePetWithForm

    Updates a pet in the store with form data

    @@ -560,10 +559,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    uploadFile

    uploads an image

    @@ -635,10 +634,10 @@

    store | - Improve this Doc + Improve this Doc - View Source + View Source

    addPet

    Add a new pet to the store

    @@ -696,10 +695,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    getInventory

    Returns pet inventories by status

    @@ -734,10 +733,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    placeOrder

    Place an order for a pet

    @@ -797,10 +796,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    deleteOrder

    Delete purchase order by ID

    @@ -862,10 +861,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    getOrderById

    Find purchase order by ID

    @@ -937,10 +936,10 @@

    user | - Improve this Doc + Improve this Doc - View Source + View Source

    createUser

    Create user

    @@ -995,10 +994,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    createUsersWithArrayInput

    Creates list of users with given input array

    @@ -1051,10 +1050,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    createUsersWithListInput

    Creates list of users with given input array

    @@ -1107,10 +1106,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    loginUser

    Logs user into the system

    @@ -1177,10 +1176,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    logoutUser

    Logs out current logged in user session

    @@ -1213,10 +1212,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    deleteUser

    Delete user

    @@ -1278,10 +1277,10 @@
    Responses
    | - Improve this Doc + Improve this Doc - View Source + View Source

    getUserByName

    Get user by user name

    @@ -1349,10 +1348,10 @@

    Other APIs | - Improve this Doc + Improve this Doc - View Source + View Source

    updateUser

    Updated user