Skip to content

Documentation: Renamed globals to variables #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
civan merged 1 commit into from
Oct 26, 2017
Merged

Documentation: Renamed globals to variables #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ $ sass-export scss/_annotations.scss -o exported-grouped.json
_output_ [exported-grouped.json]
``` javascript
{
"globals": [
"variables": [
{ "name": "$black", "value": "#000", "compiledValue": "#000" },
{ "name": "$slate", "value": "#8ca5af", "compiledValue": "#8ca5af" },
{ "name": "$global-group", "value": "#ff0000", "compiledValue": "#ff0000" }
Expand All @@ -110,7 +110,7 @@ in order to use:

``` scss
@import "breakpoints";
@import "globals";
@import "variables";

$imported-value: $bp-desktop;
$font-size: $global-font-size;
Expand All @@ -131,7 +131,7 @@ _output:_ [exported-maps.json]

```javascript
{
"globals": [
"variables": [
{
"name": "$breakpoints",
"value": "(small: 767px,\n medium: 992px,\n large: 1200px\n)",
Expand Down Expand Up @@ -216,10 +216,10 @@ var options = {
includePaths: ['libs/'] // don't forget this is the folder path not the files
};

// you can get an object {globals:[], colors: []}
// you can get an object {variables:[], colors: []}
var asObject = exporter(options).getStructured();

console.log(asObject.globals);
console.log(asObject.variables);
console.log(asObject.colors);

// or get an array [{}, {}]
Expand All @@ -244,7 +244,7 @@ Usage: sass-export [inputFiles] [options]
| ------ | ---- | ------ |
| -o, --output | String | File path where to save the JSON exported. |
| -a, --array | Boolean | If it is present, it will output an array file instead of a object structured. |
| -d, --dependencies | String[] | List of dependencies separated by comma, where Sass will try to find the @imports that your inputFiles need to work. Example: "libs/, config/, globals/". |
| -d, --dependencies | String[] | List of dependencies separated by comma, where Sass will try to find the @imports that your inputFiles need to work. Example: "libs/, config/, variables/". |
| -h, --help | Boolean | Shows up this help screen. |


Expand Down
2 changes: 1 addition & 1 deletion bin/help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Options:
--array -a If present, it will output an array file instead of a object structured.

--dependencies -d List of dependencies separated by comma, where Sass will try to find the @imports
that your inputFiles need to work. Example: "libs/, config/, globals/"
that your inputFiles need to work. Example: "libs/, config/, variables/“

--version -v Current working version.

Expand Down