You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-18Lines changed: 16 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,9 @@ All content licensed under Creative Commons Attribution 3.0 Unported License
6
6
7
7
## Summary:
8
8
9
-
> **Updated 24 June, 2014**
10
-
>
11
-
> A new branch has been created where we will swap the new markdown content and the new HTML/CSS layout for the next version. We will also clean up and remove the older unused files there as it will be virtually rewritten.
12
-
>
13
-
> Keep a watch on the `master.next` branch.
14
-
15
9
This document contains guidelines for web applications built by the Front-end development practice of Isobar. It is to be readily available to anyone who wishes to check or contribute to the iterative progress of our discipline's best practices.
16
10
17
-
This document's primary motivation is two-fold:
11
+
This document's primary motivation is two-fold:
18
12
19
13
1. code consistency and
20
14
2. best practices.
@@ -25,7 +19,7 @@ We hope to encourage other developers to think about how to best standardize the
25
19
26
20
## Intent for Build and Content
27
21
28
-
We hope to seperate the structure of the document from the content contained in the standards themselves. Effectively, our goal is to be able to easily update the content without having to worry about the structure.
22
+
We hope to separate the structure of the document from the content contained in the standards themselves. Effectively, our goal is to be able to easily update the content without having to worry about the structure.
29
23
30
24
This also enables pull requests to focus on content and forks to the content to be easily re-branded.
31
25
@@ -43,12 +37,10 @@ To make changes using the process in place, please use the build process. The ne
43
37
44
38
### Requirements
45
39
46
-
The build system uses [Grunt.js](http://gruntjs.com) via [Node.js](http://nodejs.org/) and [SASS](http://sass-lang.com/) via [Compass](http://compass-style.org/).
40
+
The build system uses [Grunt.js](http://gruntjs.com) via [Node.js](http://nodejs.org/) and [SASS](http://sass-lang.com/) via [libsass](http://libsass.org/).
47
41
48
42
First, install [Node.js](http://nodejs.org) from their Web site.
49
43
50
-
Then, prior to running the build commands, make sure you have ruby 1.9.3 installed, ideally using [RVM](https://rvm.io/rvm/install) (Mac OS X and Linux) or [RubyInstaller](http://rubyinstaller.org/downloads/) (Windows).
51
-
52
44
### Build Details
53
45
54
46
We are using [Grunt](https://github.com/gruntjs/) to run the [Assemble](https://github.com/assemble/assemble/) task to parse, populate variables, and combine files for the HTML, Markdown, and [Handlebars](http://handlebarsjs.com/) templates.
@@ -87,20 +79,25 @@ Finally, the `standards.defaultLanguage` setting determines which `*.html` file
87
79
88
80
#### Content
89
81
82
+
The content is written in Markdown files and the build converts it to HTML. Example:
83
+
90
84
```
91
-
./sections/[lang]/*.html
92
-
./sections/[lang]/*.md
85
+
./src/content/[lang]/css.md
86
+
./src/content/[lang]/general.md
87
+
./src/content/[lang]/html.md
93
88
```
94
89
95
-
Each of the `.html` files (and soon `.md` - Markdown) contained within these directories is a portion of the final output file. We have separated the different sections that make up the page into individual files so that it is easier to edit.
90
+
...and so on.
91
+
92
+
Each of the `.md` files contained within these directories is a portion of the final output file. We have separated the different sections that make up the page into individual files so that it is easier to edit.
96
93
97
94
#### Including A Content File
98
95
99
96
The content files are included as partials and the data and order is defined in the following folder and files:
100
97
101
98
```
102
-
./sections/[lang]/build/[lang].hbs
103
-
./sections/[lang]/build/data.json
99
+
./src/content/[lang]/build/[lang].hbs
100
+
./src/content/[lang]/build/data.json
104
101
```
105
102
106
103
The `data.json` file has special significance to Assemble, *do not rename this file*.
@@ -109,11 +106,12 @@ The `data.json` file has special significance to Assemble, *do not rename this f
109
106
110
107
The main layout is a Handlebars file that the content is injected into and language specific attributes are updated.
111
108
112
-
The file is `./_layouts/main.hbs`.
109
+
The file is `./src/_layouts/main.hbs`.
113
110
114
111
### Structure of CSS
115
112
116
-
The CSS files are generated via Compass from the SCSS files located in the SCSS folder, which is run as part of the Grunt task.
113
+
The CSS files are generated via LibSass from the SCSS files located in the SCSS folder, which is run as part of the Grunt task.
0 commit comments