diff --git a/pages/en/contrib/Markdown-style-guide.md b/pages/en/contrib/Markdown-style-guide.md index 474bded95..9357c0c81 100644 --- a/pages/en/contrib/Markdown-style-guide.md +++ b/pages/en/contrib/Markdown-style-guide.md @@ -41,13 +41,57 @@ as well as GitHub (and npm, as applicable). ## Headers 1. Always put spaces after the hash(es) +2. Only put one `

` header in a readme (*all* `

`s are removed by Jekyll, which adds its own). +3. Precede headers with a blank line ### Examples ```` -# This ## This + ### This -#Not this + ##Not this + ###Not this + +# This gets removed + +# This one gets removed as well + +## This is fine + +Here's a paragraph of text +## This isn't a heading!! Needs a newline above ```` + +## Blockquotes + +1. Only **unfenced** code blocks may go in block quotes. If highlighting is crucial, consider removing the block from the blockquote. + +### Examples +``` +> This: +> +> console.log('indented 4 spaces'); +> +> NOT this: +> +> ```js +> console.log('indented 4 spaces'); +> ``` +> +``` + +## Links + +1. To convert a URL to a link, wrap the URL in angle brackets. + +### Examples + +``` +https://this.will.not/create/a/link + +``` + +## Fenced Code blocks +1. Always preceed with an empty line \ No newline at end of file diff --git a/pages/en/lb2/Connecting-to-Microsoft-SQL-Server.md b/pages/en/lb2/Connecting-to-Microsoft-SQL-Server.md index 1b0194d08..e5fb96af9 100644 --- a/pages/en/lb2/Connecting-to-Microsoft-SQL-Server.md +++ b/pages/en/lb2/Connecting-to-Microsoft-SQL-Server.md @@ -2,7 +2,7 @@ title: "Microsoft SQL Server connector tutorial" lang: en layout: readme -source: loopback-example-database-mysql +source: loopback-example-database-mssql keywords: LoopBack tags: sidebar: lb2_sidebar @@ -10,4 +10,4 @@ permalink: /doc/en/lb2/Connecting-to-Microsoft-SQL-Server.html summary: A brief tutorial on using the LoopBack MS SQL connector. --- -{% include readmes/loopback-example-database-mysql.md %} +{% include readmes/loopback-example-database-mssql.md %}