Skip to content

Commit 22117e0

Browse files
committed
clean up coding style page
1 parent dcd7164 commit 22117e0

File tree

3 files changed

+19
-40
lines changed

3 files changed

+19
-40
lines changed

docs/help/style-guide.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Erdiko coding style guide
22

3-
All of the erdiko code is broken up into convenient packages that are published on either Packagist (PHP) or NPM (JavaScript & Sass). All code is stored on [Github](https://github.com/erdiko).
3+
All of the Erdiko code is broken up into convenient packages that are published on either Packagist (PHP) or NPM (JavaScript & Sass). All code is stored on [Github](https://github.com/erdiko).
44

55
Below you will find details on how we write our code. We do our best to stick to these guidelines.
66

@@ -24,16 +24,14 @@ We follow Google's JavaScript style guide.
2424
[https://google.github.io/styleguide/jsguide.html](https://google.github.io/styleguide/jsguide.html)
2525

2626

27-
## HTML
27+
## HTML / CSS
2828

29-
We follow Google's HTML style guide as well
29+
We follow Google's HTML / CSS style guide as well
3030

3131
[https://google.github.io/styleguide/htmlcssguide.html](https://google.github.io/styleguide/htmlcssguide.html)
3232

33-
34-
## CSS
35-
36-
3733
## Sass
3834

35+
We adhere to Sass best practices, but we admit there is plenty of room for improvement here as we continue to break apart front-end code into re-usable packages.
36+
3937
[http://sass-lang.com/](http://sass-lang.com/)

site/help/style-guide/index.html

+8-22
Original file line numberDiff line numberDiff line change
@@ -620,15 +620,8 @@
620620
</li>
621621

622622
<li class="md-nav__item">
623-
<a href="#html" title="HTML" class="md-nav__link">
624-
HTML
625-
</a>
626-
627-
</li>
628-
629-
<li class="md-nav__item">
630-
<a href="#css" title="CSS" class="md-nav__link">
631-
CSS
623+
<a href="#html-css" title="HTML / CSS" class="md-nav__link">
624+
HTML / CSS
632625
</a>
633626

634627
</li>
@@ -713,15 +706,8 @@
713706
</li>
714707

715708
<li class="md-nav__item">
716-
<a href="#html" title="HTML" class="md-nav__link">
717-
HTML
718-
</a>
719-
720-
</li>
721-
722-
<li class="md-nav__item">
723-
<a href="#css" title="CSS" class="md-nav__link">
724-
CSS
709+
<a href="#html-css" title="HTML / CSS" class="md-nav__link">
710+
HTML / CSS
725711
</a>
726712

727713
</li>
@@ -751,7 +737,7 @@
751737

752738

753739
<h1 id="erdiko-coding-style-guide">Erdiko coding style guide<a class="headerlink" href="#erdiko-coding-style-guide" title="Permanent link">&para;</a></h1>
754-
<p>All of the erdiko code is broken up into convenient packages that are published on either Packagist (PHP) or NPM (JavaScript &amp; Sass). All code is stored on <a href="https://github.com/erdiko">Github</a>.</p>
740+
<p>All of the Erdiko code is broken up into convenient packages that are published on either Packagist (PHP) or NPM (JavaScript &amp; Sass). All code is stored on <a href="https://github.com/erdiko">Github</a>.</p>
755741
<p>Below you will find details on how we write our code. We do our best to stick to these guidelines.</p>
756742
<h2 id="php">PHP<a class="headerlink" href="#php" title="Permanent link">&para;</a></h2>
757743
<p>We adhere to the <a href="http://www.php-fig.org/psr/psr-2/">PSR</a> coding style guide. </p>
@@ -762,11 +748,11 @@ <h2 id="php">PHP<a class="headerlink" href="#php" title="Permanent link">&para;<
762748
<h2 id="javascript">JavaScript<a class="headerlink" href="#javascript" title="Permanent link">&para;</a></h2>
763749
<p>We follow Google's JavaScript style guide.</p>
764750
<p><a href="https://google.github.io/styleguide/jsguide.html">https://google.github.io/styleguide/jsguide.html</a></p>
765-
<h2 id="html">HTML<a class="headerlink" href="#html" title="Permanent link">&para;</a></h2>
766-
<p>We follow Google's HTML style guide as well</p>
751+
<h2 id="html-css">HTML / CSS<a class="headerlink" href="#html-css" title="Permanent link">&para;</a></h2>
752+
<p>We follow Google's HTML / CSS style guide as well</p>
767753
<p><a href="https://google.github.io/styleguide/htmlcssguide.html">https://google.github.io/styleguide/htmlcssguide.html</a></p>
768-
<h2 id="css">CSS<a class="headerlink" href="#css" title="Permanent link">&para;</a></h2>
769754
<h2 id="sass">Sass<a class="headerlink" href="#sass" title="Permanent link">&para;</a></h2>
755+
<p>We adhere to Sass best practices, but we admit there is plenty of room for improvement here as we continue to break apart front-end code into re-usable packages.</p>
770756
<p><a href="http://sass-lang.com/">http://sass-lang.com/</a></p>
771757

772758

site/mkdocs/search_index.json

+6-11
Original file line numberDiff line numberDiff line change
@@ -972,12 +972,12 @@
972972
},
973973
{
974974
"location": "/help/style-guide/",
975-
"text": "Erdiko coding style guide\n\n\nAll of the erdiko code is broken up into convenient packages that are published on either Packagist (PHP) or NPM (JavaScript \n Sass). All code is stored on \nGithub\n.\n\n\nBelow you will find details on how we write our code. We do our best to stick to these guidelines.\n\n\nPHP\n\n\nWe adhere to the \nPSR\n coding style guide. \n\n\nhttp://www.php-fig.org/psr/psr-2/\n\n\nMore useful PHP-FIG links:\n\n\nhttp://www.php-fig.org/bylaws/psr-naming-conventions/\n\n\nhttp://www.php-fig.org/psr/psr-1/\n\n\nJavaScript\n\n\nWe follow Google's JavaScript style guide.\n\n\nhttps://google.github.io/styleguide/jsguide.html\n\n\nHTML\n\n\nWe follow Google's HTML style guide as well\n\n\nhttps://google.github.io/styleguide/htmlcssguide.html\n\n\nCSS\n\n\nSass\n\n\nhttp://sass-lang.com/",
975+
"text": "Erdiko coding style guide\n\n\nAll of the Erdiko code is broken up into convenient packages that are published on either Packagist (PHP) or NPM (JavaScript \n Sass). All code is stored on \nGithub\n.\n\n\nBelow you will find details on how we write our code. We do our best to stick to these guidelines.\n\n\nPHP\n\n\nWe adhere to the \nPSR\n coding style guide. \n\n\nhttp://www.php-fig.org/psr/psr-2/\n\n\nMore useful PHP-FIG links:\n\n\nhttp://www.php-fig.org/bylaws/psr-naming-conventions/\n\n\nhttp://www.php-fig.org/psr/psr-1/\n\n\nJavaScript\n\n\nWe follow Google's JavaScript style guide.\n\n\nhttps://google.github.io/styleguide/jsguide.html\n\n\nHTML / CSS\n\n\nWe follow Google's HTML / CSS style guide as well\n\n\nhttps://google.github.io/styleguide/htmlcssguide.html\n\n\nSass\n\n\nWe adhere to Sass best practices, but we admit there is plenty of room for improvement here as we continue to break apart front-end code into re-usable packages.\n\n\nhttp://sass-lang.com/",
976976
"title": "Coding style guide"
977977
},
978978
{
979979
"location": "/help/style-guide/#erdiko-coding-style-guide",
980-
"text": "All of the erdiko code is broken up into convenient packages that are published on either Packagist (PHP) or NPM (JavaScript Sass). All code is stored on Github . Below you will find details on how we write our code. We do our best to stick to these guidelines.",
980+
"text": "All of the Erdiko code is broken up into convenient packages that are published on either Packagist (PHP) or NPM (JavaScript Sass). All code is stored on Github . Below you will find details on how we write our code. We do our best to stick to these guidelines.",
981981
"title": "Erdiko coding style guide"
982982
},
983983
{
@@ -991,18 +991,13 @@
991991
"title": "JavaScript"
992992
},
993993
{
994-
"location": "/help/style-guide/#html",
995-
"text": "We follow Google's HTML style guide as well https://google.github.io/styleguide/htmlcssguide.html",
996-
"title": "HTML"
997-
},
998-
{
999-
"location": "/help/style-guide/#css",
1000-
"text": "",
1001-
"title": "CSS"
994+
"location": "/help/style-guide/#html-css",
995+
"text": "We follow Google's HTML / CSS style guide as well https://google.github.io/styleguide/htmlcssguide.html",
996+
"title": "HTML / CSS"
1002997
},
1003998
{
1004999
"location": "/help/style-guide/#sass",
1005-
"text": "http://sass-lang.com/",
1000+
"text": "We adhere to Sass best practices, but we admit there is plenty of room for improvement here as we continue to break apart front-end code into re-usable packages. http://sass-lang.com/",
10061001
"title": "Sass"
10071002
},
10081003
{

0 commit comments

Comments
 (0)