Permalink
Browse files

Attempting to make heading all conform to the same style

Re: #346
  • Loading branch information...
1 parent 25181b2 commit 24f02a55087064b0052b4e03bb8d225d211f7068 @TravisTheTechie TravisTheTechie committed Jul 6, 2015
View
@@ -14,6 +14,23 @@ For consistency across all examples in the docs and to ensure that our code exam
* When using HTML in your examples, use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags with _no trailing slash_)
* All page files should have globally unique names regardless of where they are located in the repository
+### Capitalization
+
+#### In Titles: Do Capitalize
+
+* Nouns (man, bus, book)
+* Adjectives (angry, lovely, small)
+* Verbs (run, eat, sleep)
+* Adverbs (slowly, quickly, quietly)
+* Pronouns (he, she, it)
+* Subordinating conjunctions (as, because, that)
+
+#### In Titles: Do Not Capitalize
+
+* Articles: a, an, the
+* Coordinating Conjunctions: and, but, or, for, nor, etc.
+* Prepositions: on, at, to, from, by, etc.
+
## Tools
### Assemble
@@ -53,4 +70,3 @@ body { padding-top: 80px; font-size: 12px }
* If you would like to request a feature, suggest an improvement, or report a bug, please [submit an Issue]({{ site.codeissues }}).
* Feature requests are more likely to get attention if you include a clearly-described use case.
-* If you wish to submit a pull request, please [read this first]({{ site.codebasemaster }}CONTRIBUTING).md.
View
@@ -30,6 +30,23 @@ All documentation content can be found in the `./content` directory. Please read
### Coding Style
> Please help us make the documentation _consistent, readable, and maintainable_ by conforming to these guidelines when contributing:
+#### Capitalization
+
+##### In Titles: Do Capitalize
+
+* Nouns (man, bus, book)
+* Adjectives (angry, lovely, small)
+* Verbs (run, eat, sleep)
+* Adverbs (slowly, quickly, quietly)
+* Pronouns (he, she, it)
+* Subordinating conjunctions (as, because, that)
+
+##### In Titles: Do Not Capitalize
+
+* Articles: a, an, the
+* Coordinating Conjunctions: and, but, or, for, nor, etc.
+* Prepositions: on, at, to, from, by, etc.
+
#### Markdown standards
* Use `#` for titles, not underlines. Underlines are not semantic, aren't as flexible, aren't always highlighted properly in code highlighters
@@ -62,7 +62,7 @@ The properties of the `.bordered` class will now appear in both `#menu a` and `.
* [Parametric Mixins](#mixins-parametric-feature)
-### Nested rules
+### Nested Rules
Less gives you the ability to use nesting instead of, or in combination with cascading. Let's say we have the following CSS:
@@ -116,7 +116,7 @@ You can also bundle pseudo-selectors with your mixins using this method. Here's
* [Parent Selectors](#parent-selectors-feature)
-### Nested directives and bubbling
+### Nested Directives and Bubbling
Directives such as `media` or `keyframe` can be nested in the same way as selectors. Directive is placed on top and relative order against other elements inside the same ruleset remains unchanged. This is called bubbling.
@@ -37,7 +37,7 @@ nav ul {
Notice how the `nav ul:extend(.inline)` selector gets output as `nav ul` - the extend gets removed before output and the selector block left as-is. If no properties are put in that block then it gets removed from the output (but the extend still may affect other selectors).
-## Extend syntax
+## Extend Syntax
The extend is either attached to a selector or placed into a ruleset. It looks like a pseudo-class with selector parameter optionally followed by the keyword `all`:
Example:
@@ -72,7 +72,7 @@ Example:
.e:extend(.f, .g) {}
```
-### Extend attached to selector
+### Extend Attached to Selector
Extend attached to a selector looks like an ordinary pseudo-class with selector as a parameter. A selector can contain multiple extend clauses, but all extends must be at the end of the selector.
* Extend after the selector: `pre:hover:extend(div pre)`.
@@ -90,7 +90,7 @@ If a ruleset contains multiple selectors, any of them can have the extend keywor
}
```
-### Extend inside ruleset
+### Extend Inside Ruleset
Extend can be placed into a ruleset's body using `&:extend(selector)` syntax. Placing extend into a body is a shortcut for placing it into every single selector of that ruleset.
@@ -110,7 +110,7 @@ pre:hover:extend(div pre),
.some-class:extend(div pre) {}
```
-### Extending nested Selectors
+### Extending Nested Selectors
Extend is able to match nested selectors. Following less:
Example:
@@ -202,7 +202,7 @@ link:hover:visited {
}
```
-### nth expression
+### nth Expression
Nth expression form does matter. Nth-expressions `1n+3` and `n+3` are equivalent, but extend will not match them:
@@ -576,7 +576,7 @@ Outputs
}
```
-### Combining Styles / a more advanced mixin
+### Combining Styles / A More Advanced Mixin
Another use-case is as an alternative for a mixin - because mixins can only be used with simple selectors, if you have two different blocks of html, but need to apply the same styles to both you can use extends to relate two areas.
@@ -11,7 +11,7 @@ Example:
@import "this-is-valid.less";
```
-## File extensions
+## File Extensions
`@import` statements may be treated differently by Less depending on the file extension:
* If the file has a `.css` extension it will be treated as CSS and the `@import` statement left as-is (see the [inline option](#import-options-inline) below).
@@ -38,7 +38,7 @@ Here's what we'll get:
}
```
-### Guard comparison operators
+### Guard Comparison Operators
The full list of comparison operators usable in guards are: `>`, `>=`, `=`, `=<`, `<`. Additionally, the keyword `true` is the only truthy value, making these two mixins equivalent:
@@ -67,7 +67,7 @@ Note that you can also compare arguments with each other, or with non-arguments:
.max (@a; @b) when (@a < @b) { width: @b }
```
-### Guard logical operators
+### Guard Logical Operators
You can use logical operators with guards. The syntax is based on CSS media queries.
@@ -89,7 +89,7 @@ Use the `not` keyword to negate conditions:
.mixin (@b) when not (@b > 0) { ... }
```
-### Type checking functions
+### Type Checking Functions
Lastly, if you want to match mixins based on value type, you can use the `is` functions:
@@ -113,7 +113,7 @@ If you want to check if a value is in a specific unit in addition to being a num
* `isem`
* `isunit`
-### Conditional mixins
+### Conditional Mixins
_(**FIXME**)_ Additionally, the `default` function may be used to make a mixin match depending on other mixing matches, and you may use it to create "conditional mixins" similar to `else` or `default` statements (of `if` and `case` structures respectively):
@@ -67,7 +67,7 @@ pre {
}
```
-### Mixins With Multiple Parameters
+### Mixins with Multiple Parameters
Parameters are either *semicolon* or *comma* separated. It is recommended to use *semicolon*. The symbol comma has double meaning: it can be interpreted either as a mixin parameters separator or css list separator.
Using comma as mixin separator makes it impossible to create comma separated lists as an argument. On the other hand, if the compiler sees at least one semicolon inside mixin call or declaration, it assumes that arguments are separated by semicolons and all commas belong to css lists:
@@ -139,7 +139,7 @@ compiles into:
}
```
-### The `@arguments` variable
+### The `@arguments` Variable
`@arguments` has a special meaning inside mixins, it contains all the arguments passed, when the mixin was called. This is useful if you don't want to deal with individual parameters:
@@ -164,7 +164,7 @@ Which results in:
}
```
-### Advanced arguments and the `@rest` variable
+### Advanced Arguments and the `@rest` Variable
You can use `...` if you want your mixin to take a variable number of arguments. Using this after a variable name will assign those arguments to the variable.
@@ -33,7 +33,7 @@ Notice that when you call the mixin, the parentheses are optional.
.a;
```
-## Not outputting the mixin
+## Not Outputting the Mixin
If you want to create a mixin but you do not want that mixin to be output, you can put parentheses after it.
@@ -61,7 +61,7 @@ outputs
}
```
-## Selectors in mixins
+## Selectors in Mixins
Mixins can contain more than just properties, they can contain selectors too.
@@ -141,7 +141,7 @@ results in:
```
-### Changing selector order
+### Changing Selector Order
It can be useful to prepend a selector to the inherited (parent) selectors. This can be done by putting the `&` after current selector.
For example, when using Modernizr, you might want to specify different rules based on supported features:
@@ -169,7 +169,7 @@ The selector `.no-borderradius &` will prepend `.no-borderradius` to its parent
```
-### Combinatorial explosion
+### Combinatorial Explosion
`&` can also be used to generate every possible permutation of selectors in a comma separated list:
@@ -83,7 +83,7 @@ body {
}
```
-### Import statements
+### Import Statements
Version: 1.4.0
@@ -199,7 +199,7 @@ Compiles to:
}
```
-## default variables
+## Default Variables
We sometimes get requests for default variables - an ability to set a variable only if it is not already set. This feature is not required because you can easily override a variable by putting the definition afterwards.
@@ -1,9 +1,9 @@
-#### [Download source code]({{ less.sourcearchive }}{{ less.version }}.zip)
+#### [Download Source Code]({{ less.sourcearchive }}{{ less.version }}.zip)
Get the latest Less.js source code by downloading it directly from GitHub.
-#### [Clone or fork via GitHub]({{ less.repo }})
+#### [Clone or Fork via GitHub]({{ less.repo }})
Fork the project and send us a pull request!
@@ -14,4 +14,4 @@ Install the Less.js project and JavaScript by running the following in the comma
```bash
bower install less
-```
+```
@@ -1,5 +1,5 @@
---
-title: Server-side usage
+title: Server-side Usage
---
> Less can be used on the command line via npm, downloaded as a script file for the browser or used in a wide variety of third party tools. See the [Usage]({{resolve 'usage'}}) section for more
@@ -13,7 +13,7 @@ The easiest way to install Less on the server, is via npm, the [node.js](http://
$ npm install -g less
```
-## Command-line usage
+## Command-line Usage
Once installed, you can invoke the compiler from the command-line, as such:
@@ -73,11 +73,11 @@ less.render('.class { width: (1 + 1) }',
See [Usage]({{resolve 'usage'}}) for more information.
-## Third party tools
+## Third Party Tools
See the [Usage]({{resolve 'usage'}}) section for details of other tools.
-# Command-line With Rhino
+# Command-line with Rhino
> Each less.js release contains also rhino-compatible version.
Command line rhino version requires two files:
@@ -91,7 +91,7 @@ java -jar js.jar -f less-rhino-<version>.js lessc-rhino-<version>.js styles.less
This will compile styles.less file and save the result to styles.css file. The output file parameter is optional. If it is missing, less will output the result to `stdout`.
-# Client-side usage
+# Client-side Usage
> Using less.js in the browser is great for development, but it's not recommended for production
@@ -1,5 +1,5 @@
---
-title: Browser support
+title: Browser Support
---
Less only supports running on modern browsers (recent versions of Chrome, Firefox, Safari and IE). While it is possible to use LESS on the client side in production, please be aware that there are performance implications for doing so (although the latest releases of LESS are quite a bit faster). Also, sometimes cosmetic issues can occur if a JavaScript error occurs. This is a trade off of flexibility vs. speed. For the fastest performance possible for a static web site, we recommend compiling LESS on the server side.
@@ -6,7 +6,7 @@ title: Command Line Usage
<span class="warning">Heads up! If the command line isn't your thing, learn more about [GUIs for Less](#guis-for-less).</span>
-### Installing lessc for use globally
+### Installing `lessc` for Use Globally
Install with [npm](https://www.npmjs.org/)
@@ -16,7 +16,7 @@ npm install less -g
and then you will have the `lessc` command available globally. For a specific version (or tag) you can add `@VERSION` after our package name, e.g. `npm install less@1.6.2 -g`.
-### Installing for node development
+### Installing for Node Development
Alternatively if you don't use the compiler globally, you may be after
@@ -50,7 +50,7 @@ The binary included in this repository, `bin/lessc` works with [Node.js](http://
**Usage**: `lessc [option option=parameter ...] <source> [destination]`
-### Command line usage
+### Command Line Usage
```bash
lessc [option option=parameter ...] <source> [destination]
@@ -79,7 +79,7 @@ lessc --h
Prints a help message with available options and exits.
-#### Include paths
+#### Include Paths
```bash
lessc --include-path=PATH1;PATH2
@@ -145,7 +145,7 @@ Stops any warnings from being shown.
lessc --strict-imports
```
-#### Allow imports from insecure https hosts
+#### Allow Imports from Insecure HTTPS Hosts
```bash
lessc --insecure
@@ -4,7 +4,7 @@ title: Developing Less
Thanks for thinking about contributing. Please read the [contributing instructions]({{ less.master }}CONTRIBUTING.md) carefully to avoid wasted work.
-## Install these tools
+## Install These Tools
* **node** - <http://nodejs.org/>
* **phantomjs** - <http://phantomjs.org/download.html>
@@ -31,7 +31,7 @@ Other grunt commands
* `grunt stable` to create a new release
* `grunt readme` to generate a new readme.md in the root directory (after each release)
-## How to run less in other environments
+## How to Run Less in Other Environments
If you look in the libs folder you will see `less`, `less-node`, `less-browser`. The less folder is pure javascript with no environment
specifics. if you require `less/libs/less`, you get a function that takes an environment object and an array of file managers. The file
@@ -1,5 +1,5 @@
---
-title: Editors and plugins
+title: Editors and Plugins
---
Also see: [GUIs for Less.js](#guis-for-less)
Oops, something went wrong.

0 comments on commit 24f02a5

Please sign in to comment.