Skip to content

Commit b35f75f

Browse files
dariusrosendahldariusrosendahl
committed
Documentation, link to correct JS files, variable 1.x file
1 parent 1f63208 commit b35f75f

21 files changed

+806
-524
lines changed

‎dist/buttons.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h1>Buttons</h1>
110110
<!-- Scripts for footer -->
111111
<!-- Scripts for documentation -->
112112
<footer id="footer">
113-
113+
114114
</footer>
115115
<script>
116116
$(function () {
@@ -125,13 +125,14 @@ <h1>Buttons</h1>
125125

126126
</script>
127127

128-
<script src="../js/shCore.js"></script>
129-
<script src="../js/shBrushXml.js"></script>
130-
<script src="../js/shBrushSass.js"></script>
131-
<script src="../js/shBrushJScript.js"></script>
128+
<script src="../dist/js/shCore.js"></script>
129+
<script src="../dist/js/shBrushXml.js"></script>
130+
<script src="../dist/js/shBrushSass.js"></script>
131+
<script src="../dist/js/shBrushJScript.js"></script>
132132
<script type="text/javascript">SyntaxHighlighter.all();</script>
133133
<script async defer src="https://buttons.github.io/buttons.js"></script>
134134

135+
135136
</body>
136137

137138
</html>

‎dist/css/styles.min.css‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/css/styles.min.css.map‎

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/grid.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,7 @@ <h4>Push examples</h4>
775775
<!-- Scripts for footer -->
776776
<!-- Scripts for documentation -->
777777
<footer id="footer">
778-
778+
779779
</footer>
780780
<script>
781781
$(function () {
@@ -790,13 +790,14 @@ <h4>Push examples</h4>
790790

791791
</script>
792792

793-
<script src="../js/shCore.js"></script>
794-
<script src="../js/shBrushXml.js"></script>
795-
<script src="../js/shBrushSass.js"></script>
796-
<script src="../js/shBrushJScript.js"></script>
793+
<script src="../dist/js/shCore.js"></script>
794+
<script src="../dist/js/shBrushXml.js"></script>
795+
<script src="../dist/js/shBrushSass.js"></script>
796+
<script src="../dist/js/shBrushJScript.js"></script>
797797
<script type="text/javascript">SyntaxHighlighter.all();</script>
798798
<script async defer src="https://buttons.github.io/buttons.js"></script>
799799

800+
800801
</body>
801802

802803
</html>

‎dist/index.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ <h1>CastleCSS Framework</h1>
8686
<!-- Scripts for footer -->
8787
<!-- Scripts for documentation -->
8888
<footer id="footer">
89-
89+
9090
</footer>
9191
<script>
9292
$(function () {
@@ -101,13 +101,14 @@ <h1>CastleCSS Framework</h1>
101101

102102
</script>
103103

104-
<script src="../js/shCore.js"></script>
105-
<script src="../js/shBrushXml.js"></script>
106-
<script src="../js/shBrushSass.js"></script>
107-
<script src="../js/shBrushJScript.js"></script>
104+
<script src="../dist/js/shCore.js"></script>
105+
<script src="../dist/js/shBrushXml.js"></script>
106+
<script src="../dist/js/shBrushSass.js"></script>
107+
<script src="../dist/js/shBrushJScript.js"></script>
108108
<script type="text/javascript">SyntaxHighlighter.all();</script>
109109
<script async defer src="https://buttons.github.io/buttons.js"></script>
110110

111+
111112
</body>
112113

113114
</html>

‎dist/installation.html‎

Lines changed: 73 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -71,108 +71,95 @@
7171

7272
<!-- Main -->
7373
<div class="b0_12 b4_14 b4_push_01">
74-
74+
7575
<div class="p-3x">
76-
76+
7777
<div class="block">
7878
<h1>Installation</h1>
7979
<p class="intro">A modular, updatable, easy to use SCSS Framework</p>
8080
<p>CastleCSS is built with easy updating in mind.<br />
81-
You can download the Full package and make adjustments as long as you don't update the dependencies (core, buttons, notifications, etc).</p>
81+
You can do anything as long as you don't edit the dependencies (core, buttons, notifications, etc).</p>
8282
<p>When you do adjust the dependencies, you will lose all adjustments with an update.</p>
83-
<p>There are a few ways to install:
84-
<ul>
85-
<li>Install via <a href="www.npmjs.com/">npm</a></li>
86-
<li><a href="https://www.npmjs.com/package/require">Require</a> it in your own npm package</li>
87-
<li>Download it below</li>
88-
</ul>
83+
</div>
84+
<div class="block block-invert p-3x pt-2x">
85+
<h2>Boilerplate</h2>
86+
<p>
87+
The <strong>easiest way</strong> to start is with the CastleCSS Boilerplate
88+
CastleCSS is a modular, updatable and easy to use HTML and SCSS framework. Use this Boilerplate to get started with your project right away!
89+
<div>
90+
<a class="github-button" href="https://github.com/castlecss/castlecss-boilerplate" aria-label="Watch castlecss/castlecss-boilerplate on GitHub">Watch</a>
91+
<a class="github-button" href="https://github.com/castlecss/castlecss-boilerplate" aria-label="Star castlecss/castlecss-boilerplate on GitHub">Star</a>
92+
</div>
8993
</p>
94+
<h3>What's included?</h3>
95+
<ul>
96+
<li>A simple and mobile-friendly HTML5 template to kickstart your website</li>
97+
<li>Configuration for Grunt, to easily compile and minify your Sass files</li>
98+
<li><a href="https://github.com/CastleCSS/castlecss-core" target="_blank">castlecss-core</a></li>
99+
<li><a href="https://github.com/CastleCSS/castlecss-buttons" target="_blank">castlecss-buttons</a></li>
100+
<li><a href="https://github.com/CastleCSS/castlecss-notifications" target="_blank">castlecss-notifications</a></li>
101+
</ul>
102+
<h3>
103+
Installation
104+
</h3>
105+
<div>
106+
<a class="github-button" href="https://github.com/castlecss/castlecss-boilerplate/archive/master.zip" aria-label="Download castlecss/castlecss-boilerplate on GitHub">Download</a>
107+
</div>
108+
90109
</div>
91110
<div class="block">
92-
<h2>Setup</h2>
93-
<p>Your project should have a setup similair to this (included in the Full package):<br />
94-
With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.
111+
<h2>Structure</h2>
112+
<p>The basis structure for your website should look similar like this (included in the boilerplate):<br />
95113
</p>
96114
<code class="code-structure">
97-
| Your project/<br />
115+
| Project directory/<br />
98116
|<br />
99-
|-- scss/ <br />
100-
| |-- /* Custom project specific files here */<br />
101-
| |-- Main.scss<br />
102-
| |<br />
103117
|-- node_modules/<br />
104-
| | <br />
105-
| | /* CastleCSS files included automatically here */<br />
106-
| | castlecss-core/<br />
107-
| | castlecss-buttons/<br />
108-
| | castlecss-etc ;)/<br />
118+
| | -- castlecss-core/<br />
119+
| | --castlecss-buttons/<br />
120+
| | --castlecss-notifications/<br />
121+
| |<br />
122+
|-- scss/<br />
123+
| |-- main.scss<br />
124+
| |-- variables.scss<br />
125+
| |<br />
126+
|-- img/<br />
127+
|-- dist/<br />
128+
| |-- styles.min.css<br />
129+
| |-- styles.min.map<br />
130+
| |<br />
131+
|-- index.html<br />
132+
|-- Gruntfile.js<br />
133+
|-- package.json<br />
109134
</code>
110135
<br />
111-
<p>Your main.scss should have a setup similair to this (included in the Full package):</p>
136+
<h2>Main.scss</h2>
137+
<p>Your main.scss should have a setup similair to this (included in the boilerplate):</p>
112138
<pre class="brush: sass;">
113-
/* core variable files */
139+
/* CastleCSS Core variables */
114140
@import "node_modules/castlecss-core/sass/variables";
115-
/* Your own variables so they overwrite the core */
141+
142+
/* Your variables */
116143
@import "variables";
117-
/* rest of core files */
144+
145+
/* Remaining Core files and other CastleCSS modules */
118146
@import "node_modules/castlecss-core/sass/main";
147+
@import "node_modules/castlecss-buttons/sass/main";
148+
@import "node_modules/castlecss-notifications/sass/main";
149+
150+
/* Include your own files below this line
151+
-------------------------------------- */
152+
119153

120-
/* Include your own files below this line
121-
--------------------------------------
122-
*/
154+
155+
/* --------------------------------------
156+
Include your own files above this line */
157+
158+
@import "node_modules/castlecss-core/sass/base/utility";
159+
@import "node_modules/castlecss-core/sass/base/utility_spacers";
123160
</pre>
124-
</div>
125-
<div class="block">
126-
<h2>Starting your project</h2>
127-
<p>CastleCSS uses GruntJS to build projects.</p>
128161

129-
<p>If you haven't used Grunt before, be sure to check out the <a href="http://gruntjs.com/getting-started" target="_blank">Getting Started</a> guide.</p>
130162

131-
<p>Start the project for the first time by going to your project folder in your terminal.</p>
132-
<ul>
133-
<li>Run <code>npm install</code> to install all files</li>
134-
<li>Run <code>grunt</code> to start running the project. If will automatically watch for changes in your SCSS and compile it to CSS</li>
135-
<li>Or use <code>grunt create_css</code> to create your CSS manually</li>
136-
</ul>
137-
</div>
138-
<div class="block">
139-
<div class="g">
140-
<div id="starter" class="b0_12">
141-
<div class="block block-invert p-3x pt-2x">
142-
<h2>Full package</h2>
143-
<p>
144-
<div>
145-
<a class="github-button" href="https://github.com/castlecss/castlecss" aria-label="Watch castlecss/castlecss-core on GitHub">Watch</a>
146-
<a class="github-button" href="https://github.com/castlecss/castlecss" aria-label="Star castlecss/castlecss-core on GitHub">Star</a>
147-
<a class="github-button" href="https://github.com/castlecss/castlecss/archive/master.zip" aria-label="Download castlecss/castlecss on GitHub">Download</a>
148-
</div>
149-
</p>
150-
<h3>Installation</h3>
151-
<p>
152-
<code>npm install castlecss</code><br />
153-
</p>
154-
<h3>Updating</h3>
155-
<p class="alert">
156-
<strong>NOTE:</strong> Only update the dependencies so you don't overwrite your own SCSS files. If you do update the Full package you'll overwrite everything. <br/>
157-
We recommend downloading the full package and updating the dependencies like:
158-
</p>
159-
<p>
160-
<code>npm update castlecss-core</code><br />
161-
<code>npm update castlecss-buttons</code><br />
162-
<code>npm update castlecss-notifications</code><br />
163-
</p>
164-
<h3>What's included?</h3>
165-
<p>
166-
<ul>
167-
<li><strong>Example project setup</strong></li>
168-
<li><strong>Gruntfile and task</strong></li>
169-
<li><strong>castlecss-core</strong></li>
170-
<li><strong>castlecss-buttons</strong></li>
171-
<li><strong>castlecss-notifications</strong></li>
172-
</ul>
173-
</p>
174-
</div>
175-
</div>
176163
<div id="core" class="b0_12">
177164
<div class="block block-invert p-3x pt-2x">
178165
<h2>Core only</h2>
@@ -269,7 +256,7 @@ <h3>What's included?</h3>
269256
<footer id="footer"></footer>
270257
<!-- Scripts for documentation -->
271258
<footer id="footer">
272-
259+
273260
</footer>
274261
<script>
275262
$(function () {
@@ -284,14 +271,15 @@ <h3>What's included?</h3>
284271

285272
</script>
286273

287-
<script src="../js/shCore.js"></script>
288-
<script src="../js/shBrushXml.js"></script>
289-
<script src="../js/shBrushSass.js"></script>
290-
<script src="../js/shBrushJScript.js"></script>
274+
<script src="../dist/js/shCore.js"></script>
275+
<script src="../dist/js/shBrushXml.js"></script>
276+
<script src="../dist/js/shBrushSass.js"></script>
277+
<script src="../dist/js/shBrushJScript.js"></script>
291278
<script type="text/javascript">SyntaxHighlighter.all();</script>
292279
<script async defer src="https://buttons.github.io/buttons.js"></script>
293280

294281

282+
295283
</body>
296284

297-
</html>
285+
</html>

‎dist/mixins.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ <h3>Transform mixin</h3>
134134
<!-- Scripts for footer -->
135135
<!-- Scripts for documentation -->
136136
<footer id="footer">
137-
137+
138138
</footer>
139139
<script>
140140
$(function () {
@@ -149,14 +149,15 @@ <h3>Transform mixin</h3>
149149

150150
</script>
151151

152-
<script src="../js/shCore.js"></script>
153-
<script src="../js/shBrushXml.js"></script>
154-
<script src="../js/shBrushSass.js"></script>
155-
<script src="../js/shBrushJScript.js"></script>
152+
<script src="../dist/js/shCore.js"></script>
153+
<script src="../dist/js/shBrushXml.js"></script>
154+
<script src="../dist/js/shBrushSass.js"></script>
155+
<script src="../dist/js/shBrushJScript.js"></script>
156156
<script type="text/javascript">SyntaxHighlighter.all();</script>
157157
<script async defer src="https://buttons.github.io/buttons.js"></script>
158158

159159

160+
160161
</body>
161162

162163
</html>

‎dist/notifications.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h1>Notifications / alerts</h1>
111111
<footer id="footer"></footer>
112112
<!-- Scripts for documentation -->
113113
<footer id="footer">
114-
114+
115115
</footer>
116116
<script>
117117
$(function () {
@@ -126,13 +126,14 @@ <h1>Notifications / alerts</h1>
126126

127127
</script>
128128

129-
<script src="../js/shCore.js"></script>
130-
<script src="../js/shBrushXml.js"></script>
131-
<script src="../js/shBrushSass.js"></script>
132-
<script src="../js/shBrushJScript.js"></script>
129+
<script src="../dist/js/shCore.js"></script>
130+
<script src="../dist/js/shBrushXml.js"></script>
131+
<script src="../dist/js/shBrushSass.js"></script>
132+
<script src="../dist/js/shBrushJScript.js"></script>
133133
<script type="text/javascript">SyntaxHighlighter.all();</script>
134134
<script async defer src="https://buttons.github.io/buttons.js"></script>
135135

136+
136137
</body>
137138

138139
</html>

‎dist/utility.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ <h2>Full width element</h2>
290290
<footer id="footer"></footer>
291291
<!-- Scripts for documentation -->
292292
<footer id="footer">
293-
293+
294294
</footer>
295295
<script>
296296
$(function () {
@@ -305,13 +305,14 @@ <h2>Full width element</h2>
305305

306306
</script>
307307

308-
<script src="../js/shCore.js"></script>
309-
<script src="../js/shBrushXml.js"></script>
310-
<script src="../js/shBrushSass.js"></script>
311-
<script src="../js/shBrushJScript.js"></script>
308+
<script src="../dist/js/shCore.js"></script>
309+
<script src="../dist/js/shBrushXml.js"></script>
310+
<script src="../dist/js/shBrushSass.js"></script>
311+
<script src="../dist/js/shBrushJScript.js"></script>
312312
<script type="text/javascript">SyntaxHighlighter.all();</script>
313313
<script async defer src="https://buttons.github.io/buttons.js"></script>
314314

315+
315316
</body>
316317

317318
</html>

0 commit comments

Comments
 (0)