-
Notifications
You must be signed in to change notification settings - Fork 7
/
faq.html
336 lines (268 loc) · 14.7 KB
/
faq.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
<!DOCTYPE html>
<!--[if lt IE 7]>
<html class="no-js ie lt-ie9 lt-ie8 lt-ie7" lang="en">
<![endif]-->
<!--[if IE 7]>
<html class="no-js ie lt-ie9 lt-ie8" lang="en">
<![endif]-->
<!--[if IE 8]>
<html class="no-js ie lt-ie9" lang="en">
<![endif]-->
<!--[if IE 9]>
<html class="no-js ie ie9" lang="en">
<![endif]-->
<!--[if gt IE 9]><!-->
<html class="no-js" lang="en">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<title>DocumentCSS - Frequently Asked Questions </title>
<meta name="description" content="DocumentCSS is an open source Live Style Guide creation tool, and sister to DocumentJS">
<meta name="author" content="Bitovi - DocumentCSS">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="apple-touch-icon" sizes="57x57" href="/static/img/favicons/apple-touch-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/static/img/favicons/apple-touch-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/static/img/favicons/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/static/img/favicons/apple-touch-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/static/img/favicons/apple-touch-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/static/img/favicons/apple-touch-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/static/img/favicons/apple-touch-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/static/img/favicons/apple-touch-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/static/img/favicons/apple-touch-icon-180x180.png">
<link rel="icon" type="image/png" href="/static/img/favicons/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/static/img/favicons/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/static/img/favicons/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/static/img/favicons/favicon-16x16.png" sizes="16x16">
<link rel="stylesheet" type="text/css" href="./static/bundles/static.css">
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Source+Code+Pro">
<!--[if lt IE 9]>
<script type="text/javascript" src="static/html5shiv.js"></script>
<!--<![endif]-->
</head>
<body class="faq">
<div id="greyOutUnderNav" style="display:none;"></div>
<header>
<nav class="navbar navbar-default navbar-fixed-top">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="mobile-menu-label">MENU</span>
<span class="mobile-menu-close"></span>
</button>
<div class="logo-menu">
<a class="brand" href="/index.html">DocumentCSS</a>
<ul class="dropdown-menu hidden-xs">
<li><a href="http://documentjs.com">DocumentJS</a></li>
<li><a href="http://donejs.com">DoneJS</a></li>
<li><a href="http://canjs.com">CanJS</a></li>
<li><a href="http://stealjs.com">StealJS</a></li>
<li><a href="http://jquerypp.com">jQuery++</a></li>
<li><a href="http://funcunit.com">FuncUnit</a></li>
</ul>
</div>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li >
<a href="/index.html">Home</a>
</li>
<li class="guides-menu">
<a href="/docs/index.html">Guides</a>
<ul class="dropdown-menu">
<li ><a href="/docs/quickstart.html">Quick Start</a></li>
<li><a href="/docs/setup.html">Setup</a></li>
<li ><a href="/docs/use.html">Use</a></li>
<li ><a href="/docs/customize.html">Customize</a></li>
<li ><a href="/docs/publish.html">Publish</a></li>
</ul>
</li>
<li class="examples-menu">
<a href="/examples/styles/index.html">Live Examples</a>
<ul class="dropdown-menu">
<li><a href="/examples/styles/index.html">DocumentCSS Style Guide</a></li>
<li><a href="/theme-default/index.html" target="_blank">Theme: Default</a></li>
<li><a href="/theme-classic/index.html" target="_blank">Theme: Classic</a></li>
<li><a href="/theme-bootstrap3/index.html" target="_blank">Theme: Bootstrap 3</a></li>
<li><a href="/theme-blankslate/index.html" target="_blank">Theme: Blank Slate</a></li>
</ul>
</li>
<li class="active">
<a href="/faq.html">FAQs</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right bitovi-menu">
<li class="dropdown">
<a href="http://bitovi.com" class="bitovi icon-bits">Bitovi</a>
<ul class="dropdown-menu">
<li><a href="http://bitovi.com">Bitovi.com</a></li>
<li><a href="http://bitovi.com/blog/">Blog</a></li>
<li><a href="http://bitovi.com/consulting/">Consulting</a></li>
<li><a href="http://bitovi.com/training/">Training</a></li>
<li><a href="http://bitovi.com/open-source/">Open Source</a></li>
<li><a href="http://bitovi.com/people/">People</a></li>
<li><a href="http://bitovi.com/contact/">Contact Us</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
</header>
<div class="main-content">
<section class="title">
<div class="heading">
<h1>Frequently Asked Questions</h1>
<ul class="tags">
<li>page</li>
</ul>
</div>
<div class="sub-heading">
<span class="module">faq</span>
<span class="inherits"> </span>
</div>
<ul class="links">
</ul>
<br />
</section>
<section class="contents-wrapper">
<span class="contents-title">Frequently Asked Questions</span>
<section class="contents">
</section>
</section>
<section class="comment">
<h2>Configuration Questions</h2>
<h3>Does DocumentCSS support .scss/.less/.whatever files?</h3>
<p>Yes! DocumentCSS supports all styling languages (and most development languages, this is a sibling to <a href="http://documentjs.com">DocumentJS</a> after all).</p>
<p>You can read more about how to tell it which languages you're using on the <a href="docs/setup.html#section=section_Configuration">configuration page</a> of the guides.</p>
<h3>How do I tell DocumentCSS what files to look for?</h3>
<p>DocumentCSS looks for the file types defined in your <code>documentjs.json</code> file. You'll want to edit the <code>"glob"</code> section with file paths and extensions:</p>
<pre><code>{
"sites": {
"styles": {
"glob": "styles/**/*.{less,md}", //<-Looking for LESS and Markdown files in folders inside the styles folder.
"dest": "styleguide",
"parent": "styles"
}
}
}</code></pre>
<p>You can read more about this on the <a href="docs/setup.html#section=section_Configuration">configuration page</a> of the guides.</p>
<h3>Is there a simple project I can download that works out of the box?</h3>
<p>There is! <a href="https:/brandonreid">Brandon Reid</a> awesomely put a two-pagestyle guide together for people to play around with. You can find it on Github at: <a href="https:/brandonreid/documentcss_starter-kit">DocumentCSS Starter Kit</a>.</p>
<h2>Customization Questions</h2>
<h3>How do I override DocumentCSS styles?</h3>
<p>Here's a high-level overview of the process: You tell <code>documentjs.json</code> to look for your custom template/LESS files, and then these new files need to match the DocumentJS <a href="docs/setup.html#section=section_FileOrganization">file structure</a>.</p>
<p>The easiest way to go about this is to copy the <a href="https:/bitovi/documentjs/tree/master/site/default">default DocumentJS theme</a> to your own project and modify it. We also have a few different themes you can use on our <a href="https:/bitovi/bootdocs/tree/master/themes">Bootdocs</a> project.</p>
<p>You can get a full breakdown of how to customize your version of DocumentCSS in the <a href="/docs/customize.html">customizing look and feel</a> section of the guides. We hope that future versions of DocumentJS will have an easier theming engine.</p>
<h3>Can I restyle DocumentCSS in SCSS instead of LESS?</h3>
<p>Short answer: not easily.</p>
<p>DocumentCSS is built in LESS and stripping that out in favor of writing styles in another language would be a huge task. With enough time and patience, anything is possible though.</p>
<h3>How do I update the menu?</h3>
<p>The top menu is of your Living Style Guide is hardcoded into the theme files. You can learn how to update by following <a href="/docs/use.html#section=section_UpdatingtheTopMenu">this guide</a>.</p>
<h3>Why isn't my theme updating?</h3>
<p>To save time, DocumentJS doesn’t re-build the theme every time the site is generated. In order to get the theme or main navigation to update you have to force the documentjs task. You can do this with the <code>-f</code> flag:</p>
<pre><code>> documentjs -f</code></pre>
<p>You can force and watch at the same time too:</p>
<pre><code>> documentjs -f -w</code></pre>
<p>Depending on the size of your documentation site, this can take a long time. So we recommend dropping the <code>-f</code> unless you're editing the template itself. Documentation comments and demos shouldn't need to be forced.</p>
<h2>Troubleshooting Questions</h2>
<h3>Why are demos returning 404s?</h3>
<p>This is because of one of two issues:</p>
<ol>
<li><p>The path is wrong/there's a typo. Double-check the location of your demo files in relation to the compiled documentation files. If you follow our <a href="/docs/setup.html#section=section_FileOrganization">file structure</a> in the guides, you demos should be accessible by using this path:</p>
<pre><code>@demo demos/forms.html</code></pre></li>
<li><p>The demo doesn't exist yet. I pre-link to demos in documentation comments and then forget to actually create the demo all the time.</p></li>
</ol>
<blockquote>
<p><strong>It’s important to know that DocumentJS does not move or copy your demos to the generated site folder. Using <code>@demo</code> only tells DocumentJS to create a link to that location. We hope that future versions of DocumentJS will handle this for us.</strong></p>
</blockquote>
<h3>Why aren't demos pulling the right styles?</h3>
<p>The demos are highly manual right now and embedded in iframes. What this means is that you'll need to manually link to the compiled stylesheet for your application. You can either use a relative path to the distribution folder your application compiles to, or if your css is hosted online, you can link to that.</p>
<p>Example: For the demos in our DocumentCSS documentation of Bootstrap elements, <a href="https:/bitovi/bootdocs">Bootdocs</a>, we linked to the Bootstrap CDN so our demos will always reflect any changes Bootstrap makes.</p>
<pre><code><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css" />
</code></pre>
<p>For the demos on this website, <a href="/examples/styles/index.html">documenting the styles these guides are using</a>, we used a relative path.</p>
<pre><code><link rel="stylesheet" href="./static/bundles/static.css" />
</code></pre>
<p>So if you have:</p>
<pre><code>@demo demos/forms.html</code></pre>
<p>Then the <code>forms.html</code> file should have a reference to the CSS in the <code><head></code> of the HTML. We hope future versions of DocumentJS will automate the inclusion of CSS in demos to make this easier.</p>
<h3>How do I get the '@' symbol to display in my documentation? I keep getting a warning!</h3>
<p>If your style guide includes content with the <code>@</code>symbol, like a LESS variable name or media queries, DocumentJS returns a warning because this is the same character it uses to denote relationships and content within the style guide.</p>
<p>So if you see:</p>
<pre><code> WARNING!!
There is no @foo tag. did you mean @add ? </code></pre>
<p>Simply use two '@'s like so: <code>@@variable-name</code>.</p>
</section>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-12 col-sm-8">
<div class="col-xs-1 footer-brand">
<a href="/"><img src="/static/img/logo-doc-css-white.svg"></a>
</div>
<ul class="footer-nav-main list-stacked">
<li>
<a href="/">HOME</a>
</li>
<li>
<a href="/Guides.html">GUIDES</a>
</li>
<li>
<a href="/examples/styles/index.html">LIVE EXAMPLE</a>
</li>
<li>
<a href="/faq.html">FAQS</a>
</li>
</ul>
</div>
<div class="col-xs-12 col-sm-4">
<ul class="footer-nav-social list-stacked">
<li>
<a href="https:/bitovi/documentcss">
<img class="footer-social-icon" src="/static/img/icon-github-white.svg">
</a>
</li>
<li>
<a href="https://twitter.com/documentjs">
<img class="footer-social-icon" src="/static/img/icon-twitter-white.svg">
</a>
</li>
</ul>
</div>
<div class="footer-copyright col-sm-12">
© <a href="http://www.bitovi.com">2016 Bitovi, Inc.</a>
</div>
</div>
</div>
</footer>
<script type="text/javascript">
var docObject = {"type":"page","name":"faq","src":"pages/faq.md","description":"","title":"Frequently Asked Questions","hideSidebar":true,"dest":"/Users/tomgreever/server/documentcss/","glob":{"pattern":"pages/*.md","ignore":"{pages/guides.md,pages/guides/**/*,pages/styles.md}","cwd":"/Users/tomgreever/server/documentcss"},"templates":"/Users/tomgreever/server/documentcss/theme/donejs/templates","static":"/Users/tomgreever/server/documentcss/theme/donejs/static","forceBuild":true,"generators":["html"],"docConfigDest":"documentjs.json","project":{}};
</script>
<script>
steal = {
instantiated: {
"bundles/static.css!$css" : null
}
}
</script>
<script type='text/javascript'
data-main="static"
data-config="./static/config.js"
src="./static/steal.production.js"
bundles-path="bundles"></script>
<!-- Start of Async HubSpot Analytics Code -->
<script type="text/javascript">
(function(d,s,i,r) {
if (d.getElementById(i)){return;}
var n=d.createElement(s),e=d.getElementsByTagName(s)[0];
n.id=i;n.src='//js.hs-analytics.net/analytics/'+(Math.ceil(new Date()/r)*r)+'/2171535.js';
e.parentNode.insertBefore(n, e);
})(document,"script","hs-analytics",300000);
</script>
<!-- End of Async HubSpot Analytics Code -->
</body>
</html>