9 |
10 |
11 |
12 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/__test__/browser.js:
--------------------------------------------------------------------------------
1 | eye.test("Browser", "browser", path.join(__testDir, "browser.html"))
2 |
--------------------------------------------------------------------------------
/docs/.editorconfig:
--------------------------------------------------------------------------------
1 | # editorconfig.org
2 |
3 | root = true
4 |
5 | [*]
6 | charset = utf-8
7 | indent_size = 4
8 | indent_style = space
9 | insert_final_newline = true
10 | trim_trailing_whitespace = true
11 |
12 | [*.md]
13 | trim_trailing_whitespace = false
14 |
--------------------------------------------------------------------------------
/docs/.gitattributes:
--------------------------------------------------------------------------------
1 | ## GITATTRIBUTES FOR WEB PROJECTS
2 | #
3 | # These settings are for any web project.
4 | #
5 | # Details per file setting:
6 | # text These files should be normalized (i.e. convert CRLF to LF).
7 | # binary These files are binary and should be left untouched.
8 | #
9 | # Note that binary is a macro for -text -diff.
10 | ######################################################################
11 |
12 | ## AUTO-DETECT
13 | ## Handle line endings automatically for files detected as
14 | ## text and leave all files detected as binary untouched.
15 | ## This will handle all files NOT defined below.
16 | * text=auto
17 |
18 | ## SOURCE CODE
19 | *.bat text eol=crlf
20 | *.coffee text
21 | *.css text
22 | *.htm text
23 | *.html text
24 | *.inc text
25 | *.ini text
26 | *.js text
27 | *.json text
28 | *.jsx text
29 | *.less text
30 | *.od text
31 | *.onlydata text
32 | *.php text
33 | *.pl text
34 | *.py text
35 | *.rb text
36 | *.sass text
37 | *.scm text
38 | *.scss text
39 | *.sh text eol=lf
40 | *.sql text
41 | *.styl text
42 | *.tag text
43 | *.ts text
44 | *.tsx text
45 | *.xml text
46 | *.xhtml text
47 |
48 | ## DOCKER
49 | *.dockerignore text
50 | Dockerfile text
51 |
52 | ## DOCUMENTATION
53 | *.markdown text
54 | *.md text
55 | *.mdwn text
56 | *.mdown text
57 | *.mkd text
58 | *.mkdn text
59 | *.mdtxt text
60 | *.mdtext text
61 | *.txt text
62 | AUTHORS text
63 | CHANGELOG text
64 | CHANGES text
65 | CONTRIBUTING text
66 | COPYING text
67 | copyright text
68 | *COPYRIGHT* text
69 | INSTALL text
70 | license text
71 | LICENSE text
72 | NEWS text
73 | readme text
74 | *README* text
75 | TODO text
76 |
77 | ## TEMPLATES
78 | *.dot text
79 | *.ejs text
80 | *.haml text
81 | *.handlebars text
82 | *.hbs text
83 | *.hbt text
84 | *.jade text
85 | *.latte text
86 | *.mustache text
87 | *.njk text
88 | *.phtml text
89 | *.tmpl text
90 | *.tpl text
91 | *.twig text
92 |
93 | ## LINTERS
94 | .csslintrc text
95 | .eslintrc text
96 | .htmlhintrc text
97 | .jscsrc text
98 | .jshintrc text
99 | .jshintignore text
100 | .stylelintrc text
101 |
102 | ## CONFIGS
103 | *.bowerrc text
104 | *.cnf text
105 | *.conf text
106 | *.config text
107 | .browserslistrc text
108 | .editorconfig text
109 | .gitattributes text
110 | .gitconfig text
111 | .gitignore text
112 | .htaccess text
113 | *.npmignore text
114 | *.yaml text
115 | *.yml text
116 | browserslist text
117 | Makefile text
118 | makefile text
119 |
120 | ## HEROKU
121 | Procfile text
122 | .slugignore text
123 |
124 | ## GRAPHICS
125 | *.ai binary
126 | *.bmp binary
127 | *.eps binary
128 | *.gif binary
129 | *.ico binary
130 | *.jng binary
131 | *.jp2 binary
132 | *.jpg binary
133 | *.jpeg binary
134 | *.jpx binary
135 | *.jxr binary
136 | *.pdf binary
137 | *.png binary
138 | *.psb binary
139 | *.psd binary
140 | *.svg text
141 | *.svgz binary
142 | *.tif binary
143 | *.tiff binary
144 | *.wbmp binary
145 | *.webp binary
146 |
147 | ## AUDIO
148 | *.kar binary
149 | *.m4a binary
150 | *.mid binary
151 | *.midi binary
152 | *.mp3 binary
153 | *.ogg binary
154 | *.ra binary
155 |
156 | ## VIDEO
157 | *.3gpp binary
158 | *.3gp binary
159 | *.as binary
160 | *.asf binary
161 | *.asx binary
162 | *.fla binary
163 | *.flv binary
164 | *.m4v binary
165 | *.mng binary
166 | *.mov binary
167 | *.mp4 binary
168 | *.mpeg binary
169 | *.mpg binary
170 | *.ogv binary
171 | *.swc binary
172 | *.swf binary
173 | *.webm binary
174 |
175 | ## ARCHIVES
176 | *.7z binary
177 | *.gz binary
178 | *.jar binary
179 | *.rar binary
180 | *.tar binary
181 | *.zip binary
182 |
183 | ## FONTS
184 | *.ttf binary
185 | *.eot binary
186 | *.otf binary
187 | *.woff binary
188 | *.woff2 binary
189 |
190 | ## EXECUTABLES
191 | *.exe binary
192 | *.pyc binary
193 |
--------------------------------------------------------------------------------
/docs/.gitignore:
--------------------------------------------------------------------------------
1 | # Include your project-specific ignores in this file
2 | # Read about how to use .gitignore: https://help.github.com/articles/ignoring-files
3 | # Useful .gitignore templates: https://github.com/github/gitignore
4 |
--------------------------------------------------------------------------------
/docs/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Page Not Found
6 |
7 |
54 |
55 |
56 |
Page Not Found
57 |
Sorry, but the page you were trying to view does not exist.
58 |
59 |
60 |
61 |
--------------------------------------------------------------------------------
/docs/CNAME:
--------------------------------------------------------------------------------
1 | theorem.js.org
--------------------------------------------------------------------------------
/docs/LICENSE.txt:
--------------------------------------------------------------------------------
1 | Copyright (c) HTML5 Boilerplate
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of
4 | this software and associated documentation files (the "Software"), to deal in
5 | the Software without restriction, including without limitation the rights to
6 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7 | of the Software, and to permit persons to whom the Software is furnished to do
8 | so, subject to the following conditions:
9 |
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 |
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19 | SOFTWARE.
20 |
--------------------------------------------------------------------------------
/docs/browserconfig.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/desc/.editorconfig:
--------------------------------------------------------------------------------
1 | # editorconfig.org
2 |
3 | root = true
4 |
5 | [*]
6 | charset = utf-8
7 | indent_size = 4
8 | indent_style = space
9 | insert_final_newline = true
10 | trim_trailing_whitespace = true
11 |
12 | [*.md]
13 | trim_trailing_whitespace = false
14 |
--------------------------------------------------------------------------------
/docs/desc/.gitattributes:
--------------------------------------------------------------------------------
1 | ## GITATTRIBUTES FOR WEB PROJECTS
2 | #
3 | # These settings are for any web project.
4 | #
5 | # Details per file setting:
6 | # text These files should be normalized (i.e. convert CRLF to LF).
7 | # binary These files are binary and should be left untouched.
8 | #
9 | # Note that binary is a macro for -text -diff.
10 | ######################################################################
11 |
12 | ## AUTO-DETECT
13 | ## Handle line endings automatically for files detected as
14 | ## text and leave all files detected as binary untouched.
15 | ## This will handle all files NOT defined below.
16 | * text=auto
17 |
18 | ## SOURCE CODE
19 | *.bat text eol=crlf
20 | *.coffee text
21 | *.css text
22 | *.htm text
23 | *.html text
24 | *.inc text
25 | *.ini text
26 | *.js text
27 | *.json text
28 | *.jsx text
29 | *.less text
30 | *.od text
31 | *.onlydata text
32 | *.php text
33 | *.pl text
34 | *.py text
35 | *.rb text
36 | *.sass text
37 | *.scm text
38 | *.scss text
39 | *.sh text eol=lf
40 | *.sql text
41 | *.styl text
42 | *.tag text
43 | *.ts text
44 | *.tsx text
45 | *.xml text
46 | *.xhtml text
47 |
48 | ## DOCKER
49 | *.dockerignore text
50 | Dockerfile text
51 |
52 | ## DOCUMENTATION
53 | *.markdown text
54 | *.md text
55 | *.mdwn text
56 | *.mdown text
57 | *.mkd text
58 | *.mkdn text
59 | *.mdtxt text
60 | *.mdtext text
61 | *.txt text
62 | AUTHORS text
63 | CHANGELOG text
64 | CHANGES text
65 | CONTRIBUTING text
66 | COPYING text
67 | copyright text
68 | *COPYRIGHT* text
69 | INSTALL text
70 | license text
71 | LICENSE text
72 | NEWS text
73 | readme text
74 | *README* text
75 | TODO text
76 |
77 | ## TEMPLATES
78 | *.dot text
79 | *.ejs text
80 | *.haml text
81 | *.handlebars text
82 | *.hbs text
83 | *.hbt text
84 | *.jade text
85 | *.latte text
86 | *.mustache text
87 | *.njk text
88 | *.phtml text
89 | *.tmpl text
90 | *.tpl text
91 | *.twig text
92 |
93 | ## LINTERS
94 | .csslintrc text
95 | .eslintrc text
96 | .htmlhintrc text
97 | .jscsrc text
98 | .jshintrc text
99 | .jshintignore text
100 | .stylelintrc text
101 |
102 | ## CONFIGS
103 | *.bowerrc text
104 | *.cnf text
105 | *.conf text
106 | *.config text
107 | .browserslistrc text
108 | .editorconfig text
109 | .gitattributes text
110 | .gitconfig text
111 | .gitignore text
112 | .htaccess text
113 | *.npmignore text
114 | *.yaml text
115 | *.yml text
116 | browserslist text
117 | Makefile text
118 | makefile text
119 |
120 | ## HEROKU
121 | Procfile text
122 | .slugignore text
123 |
124 | ## GRAPHICS
125 | *.ai binary
126 | *.bmp binary
127 | *.eps binary
128 | *.gif binary
129 | *.ico binary
130 | *.jng binary
131 | *.jp2 binary
132 | *.jpg binary
133 | *.jpeg binary
134 | *.jpx binary
135 | *.jxr binary
136 | *.pdf binary
137 | *.png binary
138 | *.psb binary
139 | *.psd binary
140 | *.svg text
141 | *.svgz binary
142 | *.tif binary
143 | *.tiff binary
144 | *.wbmp binary
145 | *.webp binary
146 |
147 | ## AUDIO
148 | *.kar binary
149 | *.m4a binary
150 | *.mid binary
151 | *.midi binary
152 | *.mp3 binary
153 | *.ogg binary
154 | *.ra binary
155 |
156 | ## VIDEO
157 | *.3gpp binary
158 | *.3gp binary
159 | *.as binary
160 | *.asf binary
161 | *.asx binary
162 | *.fla binary
163 | *.flv binary
164 | *.m4v binary
165 | *.mng binary
166 | *.mov binary
167 | *.mp4 binary
168 | *.mpeg binary
169 | *.mpg binary
170 | *.ogv binary
171 | *.swc binary
172 | *.swf binary
173 | *.webm binary
174 |
175 | ## ARCHIVES
176 | *.7z binary
177 | *.gz binary
178 | *.jar binary
179 | *.rar binary
180 | *.tar binary
181 | *.zip binary
182 |
183 | ## FONTS
184 | *.ttf binary
185 | *.eot binary
186 | *.otf binary
187 | *.woff binary
188 | *.woff2 binary
189 |
190 | ## EXECUTABLES
191 | *.exe binary
192 | *.pyc binary
193 |
--------------------------------------------------------------------------------
/docs/desc/.gitignore:
--------------------------------------------------------------------------------
1 | # Include your project-specific ignores in this file
2 | # Read about how to use .gitignore: https://help.github.com/articles/ignoring-files
3 | # Useful .gitignore templates: https://github.com/github/gitignore
4 |
--------------------------------------------------------------------------------
/docs/desc/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Page Not Found
6 |
7 |
54 |
55 |
56 |
Page Not Found
57 |
Sorry, but the page you were trying to view does not exist.
58 |
59 |
60 |
61 |
--------------------------------------------------------------------------------
/docs/desc/LICENSE.txt:
--------------------------------------------------------------------------------
1 | Copyright (c) HTML5 Boilerplate
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of
4 | this software and associated documentation files (the "Software"), to deal in
5 | the Software without restriction, including without limitation the rights to
6 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7 | of the Software, and to permit persons to whom the Software is furnished to do
8 | so, subject to the following conditions:
9 |
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 |
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19 | SOFTWARE.
20 |
--------------------------------------------------------------------------------
/docs/desc/android-chrome-192x192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/android-chrome-192x192.png
--------------------------------------------------------------------------------
/docs/desc/android-chrome-512x512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/android-chrome-512x512.png
--------------------------------------------------------------------------------
/docs/desc/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/apple-touch-icon.png
--------------------------------------------------------------------------------
/docs/desc/browserconfig.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | #da532c
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/docs/desc/config.json:
--------------------------------------------------------------------------------
1 | [{
2 | "type": "github",
3 | "title": "Descartes",
4 | "url": "https://github.com/arguiot/Descartes/wiki",
5 | "logo": "https://arguiot.github.io/Descartes/assets/logo.svg",
6 | "copyright": "Arthur Guiot",
7 | "analytics": "UA-109503398-4"
8 | }]
9 |
--------------------------------------------------------------------------------
/docs/desc/css/main.css:
--------------------------------------------------------------------------------
1 | /*! HTML5 Boilerplate v6.0.1 | MIT License | https://html5boilerplate.com/ */html{color:#222;font-size:1em;line-height:1.4}::-moz-selection{background:#b3d4fc;text-shadow:none}::selection{background:#b3d4fc;text-shadow:none}hr{display:block;height:1px;border:0;border-top:1px solid #ccc;margin:1em 0;padding:0}audio,canvas,iframe,img,svg,video{vertical-align:middle}fieldset{border:0;margin:0;padding:0}textarea{resize:vertical}.browserupgrade{margin:0.2em 0;background:#ccc;color:#000;padding:0.2em 0}body{overflow-x:hidden}.sidebar{position:fixed;top:0;left:-290px;width:300px;height:100vh;background:transparent;-webkit-transition:all 500ms ease-in-out;transition:all 500ms ease-in-out;overflow-x:hidden;overflow-y:hidden;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-size:16px;line-height:1.5;word-wrap:break-word;padding:20px}@media (min-width: 500px){.sidebar:hover{position:fixed;left:0px;width:300px;background:#333;z-index:10;overflow-y:scroll}.sidebar:hover+.arrow{-webkit-transition:all 500ms ease-in-out;transition:all 500ms ease-in-out;left:300px;background:transparent}}.hovered{position:fixed;left:0px;width:300px;background:#333;z-index:10;overflow-y:scroll}.sidebar ul>li{color:white}.sidebar ul>li>a{color:white;text-decoration:none}.sidebar ul>li>a:hover{cursor:pointer;text-decoration:underline}.anchor{display:none}.arrow{width:50px;height:50px;background:#333;color:white;position:fixed;left:0;top:calc(50vh - 25px);z-index:-100;text-align:center;line-height:50px}.hovered+arrow{-webkit-transition:all 500ms ease-in-out;transition:all 500ms ease-in-out;left:300px;background:transparent}.copyright{font-family:'Roboto', sans-serif;width:100vw;text-align:center;color:#616161;margin-bottom:30px}.copyright:hover{text-decoration:underline;cursor:pointer}.copyright-side{font-family:'Roboto', sans-serif;color:#616161;margin-bottom:30px}.title{width:100vw;text-align:center;height:80px;position:fixed;top:0;font-weight:normal;font-size:32px;line-height:80px;word-wrap:break-word;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";background:#fff;border-bottom:1px solid #eee}.img{width:150px;max-height:150px}.content{width:calc(90vw - 100px);max-width:800px;margin:0 auto;margin-top:80px;padding:50px;word-wrap:break-word}.hidden{display:none !important}.visuallyhidden{border:0;clip:rect(0 0 0 0);-webkit-clip-path:inset(50%);clip-path:inset(50%);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px;white-space:nowrap}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;-webkit-clip-path:none;clip-path:none;height:auto;margin:0;overflow:visible;position:static;width:auto;white-space:inherit}.invisible{visibility:hidden}.clearfix:before,.clearfix:after{content:" ";display:table}.clearfix:after{clear:both}@media print{*,*:before,*:after{background:transparent !important;color:#000 !important;-webkit-box-shadow:none !important;box-shadow:none !important;text-shadow:none !important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="#"]:after,a[href^="javascript:"]:after{content:""}pre{white-space:pre-wrap !important}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}}
2 |
--------------------------------------------------------------------------------
/docs/desc/css/normalize.css:
--------------------------------------------------------------------------------
1 | /*! normalize.css v7.0.0 | MIT License | github.com/necolas/normalize.css */html{line-height:1.15;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,footer,header,nav,section{display:block}h1{font-size:2em;margin:0.67em 0}figcaption,figure,main{display:block}figure{margin:1em 40px}hr{-webkit-box-sizing:content-box;box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace, monospace;font-size:1em}a{background-color:transparent;-webkit-text-decoration-skip:objects}abbr[title]{border-bottom:none;text-decoration:underline;-webkit-text-decoration:underline dotted;text-decoration:underline dotted}b,strong{font-weight:inherit}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace, monospace;font-size:1em}dfn{font-style:italic}mark{background-color:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-0.25em}sup{top:-0.5em}audio,video{display:inline-block}audio:not([controls]){display:none;height:0}img{border-style:none}svg:not(:root){overflow:hidden}button,input,optgroup,select,textarea{font-family:sans-serif;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}button,html [type="button"],[type="reset"],[type="submit"]{-webkit-appearance:button}button::-moz-focus-inner,[type="button"]::-moz-focus-inner,[type="reset"]::-moz-focus-inner,[type="submit"]::-moz-focus-inner{border-style:none;padding:0}button:-moz-focusring,[type="button"]:-moz-focusring,[type="reset"]:-moz-focusring,[type="submit"]:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:0.35em 0.75em 0.625em}legend{-webkit-box-sizing:border-box;box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{display:inline-block;vertical-align:baseline}textarea{overflow:auto}[type="checkbox"],[type="radio"]{-webkit-box-sizing:border-box;box-sizing:border-box;padding:0}[type="number"]::-webkit-inner-spin-button,[type="number"]::-webkit-outer-spin-button{height:auto}[type="search"]{-webkit-appearance:textfield;outline-offset:-2px}[type="search"]::-webkit-search-cancel-button,[type="search"]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details,menu{display:block}summary{display:list-item}canvas{display:inline-block}template{display:none}[hidden]{display:none}
2 |
--------------------------------------------------------------------------------
/docs/desc/doc/TOC.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/)
2 |
3 | ## Getting started
4 |
5 | * [Usage](usage.md) — Overview of the project contents.
6 | * [FAQ](faq.md) — Frequently asked questions along with their answers.
7 |
8 | ## HTML5 Boilerplate core
9 |
10 | * [HTML](html.md) — Guide to the default HTML.
11 | * [CSS](css.md) — Guide to the default CSS.
12 | * [JavaScript](js.md) — Guide to the default JavaScript.
13 | * [Everything else](misc.md).
14 |
15 | ## Development
16 |
17 | * [Extending and customizing HTML5 Boilerplate](extend.md) — Going further
18 | with the boilerplate.
19 |
20 | ## Related projects
21 |
22 | The [H5BP organization](https://github.com/h5bp) maintains several projects
23 | that complement HTML5 Boilerplate, projects that can help you improve different
24 | aspects of your website/web app (e.g.: the performance, security, etc.).
25 |
26 | * [Server Configs](https://github.com/h5bp/server-configs) — Fast and
27 | smart configurations for web servers such as Apache and Nginx.
28 | * [Apache](https://github.com/h5bp/server-configs-apache)
29 | * [Google App Engine (GAE)](https://github.com/h5bp/server-configs-gae)
30 | * [Internet Information Services (IIS)](https://github.com/h5bp/server-configs-iis)
31 | * [lighttpd](https://github.com/h5bp/server-configs-lighttpd)
32 | * [Nginx](https://github.com/h5bp/server-configs-nginx)
33 | * [Node.js](https://github.com/h5bp/server-configs-node)
34 | * [Ant Build Script](https://github.com/h5bp/ant-build-script) — Apache
35 | Ant based build script.
36 |
--------------------------------------------------------------------------------
/docs/desc/doc/faq.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # Frequently asked questions
5 |
6 | * [Why is the Google Analytics code at the bottom? Google recommends it be
7 | placed in the ``.](#why-is-the-google-analytics-code-at-the-bottom-google-recommends-it-be-placed-in-the-head)
8 | * [How can I integrate Bootstrap with HTML5
9 | Boilerplate?](#how-can-i-integrate-bootstrap-with-html5-boilerplate)
10 | * [Do I need to upgrade my site each time a new version of HTML5 Boilerplate is
11 | released?](#do-i-need-to-upgrade-my-site-each-time-a-new-version-of-html5-boilerplate-is-released)
12 | * [Where can I get help with support
13 | questions?](#where-can-i-get-help-with-support-questions)
14 |
15 | ---
16 |
17 | ### Why is the Google Analytics code at the bottom? Google recommends it be placed in the ``.
18 |
19 | The main advantage of placing it in the `` is that you will track the
20 | user's `pageview` even if they leave the page before it has been fully loaded.
21 |
22 | Here's a handy quote from [Mathias Bynens](https://mathiasbynens.be/notes/async-analytics-snippet#comment-50) about our placement choice.
23 | >I should point out that it’s Google — not me — recommending to place this
24 | script before all other scripts in the document. The only real advantage is to
25 | catch a pageView call if your page fails to load completely (for example, if
26 | the user aborts loading, or quickly closes the page, etc.). Personally, I
27 | wouldn’t count that as a page view, so I actually prefer to place this script
28 | at the bottom, after all other scripts. This keeps all the scripts together and
29 | reinforces that scripts at the bottom are the right move. (Usually I
30 | concatenate and minify all my scripts into one .js file — the GA snippet being
31 | the suffix.)
32 |
33 | ### How can I integrate [Bootstrap](https://getbootstrap.com/) with HTML5 Boilerplate?
34 |
35 | Here's Nicolas Gallagher writing about how [HTML5 Boilerplate and Bootstrap complement each
36 | other](https://www.quora.com/Is-Bootstrap-a-complement-or-an-alternative-to-HTML5-Boilerplate-or-viceversa/answer/Nicolas-Gallagher).
37 |
38 | ### Do I need to upgrade my site each time a new version of HTML5 Boilerplate is released?
39 |
40 | No, same as you don't normally replace the foundation of a house once it
41 | was built. However, there is nothing stopping you from trying to work in the
42 | latest changes, but you'll have to assess the costs/benefits of doing so.
43 |
44 | ### Where can I get help with support questions?
45 |
46 | Please ask for help on
47 | [StackOverflow](https://stackoverflow.com/questions/tagged/html5boilerplate).
48 |
--------------------------------------------------------------------------------
/docs/desc/doc/js.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # The JavaScript
5 |
6 | Information about the default JavaScript included in the project.
7 |
8 | ## main.js
9 |
10 | This file can be used to contain or reference your site/app JavaScript code.
11 | If you're working on something more advanced you might replace this file
12 | entirely. That's cool.
13 |
14 | ## plugins.js
15 |
16 | This file can be used to contain all your plugins, such as jQuery plugins and
17 | other 3rd party scripts for a simple site.
18 |
19 | One approach is to put jQuery plugins inside of a `(function($){ ...
20 | })(jQuery);` closure to make sure they're in the jQuery namespace safety
21 | blanket. Read more about [jQuery plugin
22 | authoring](https://learn.jquery.com/plugins/#Getting_Started).
23 |
24 | By default the `plugins.js` file contains a small script to avoid `console`
25 | errors in browsers that lack a `console`. The script will make sure that, if
26 | a console method isn't available, that method will have the value of empty
27 | function, thus, preventing the browser from throwing an error.
28 |
29 | ## vendor
30 |
31 | This directory can be used to contain all 3rd party library code.
32 |
33 | Minified versions of the latest jQuery and Modernizr libraries are included by
34 | default. You may wish to create your own [custom Modernizr
35 | build with the online builder](https://www.modernizr.com/download/) or [command
36 | line tool](https://modernizr.com/docs#command-line-config).
37 |
--------------------------------------------------------------------------------
/docs/desc/doc/usage.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # Usage
5 |
6 | The most basic usage of HTML5 Boilerplate is to create a static site or simple
7 | app. Once you've downloaded or cloned the project, that process looks something
8 | like this:
9 |
10 | 1. Set up the basic structure of the site.
11 | 2. Add some content, style, and functionality.
12 | 3. Run your site locally to see how it looks.
13 | 4. Deploy your site.
14 |
15 | Cool, right? _It is_. That said, the smart defaults, baseline elements, default
16 | attribute values and various other utilities that HTML5 Boilerplate offers can
17 | serve as the foundation for whatever you're interested in building.
18 |
19 | Even the basic use-case of a simple static site can be enhanced by manipulating
20 | the code through an automated build process. Moving up in complexity HTML5
21 | Boilerplate can be be integrated with whatever front-end framework, CMS or
22 | e-commerce platform you're working with. Mix-and-match to your heart's content.
23 | Use what you need (toss it in a blender if you need to) and discard the rest.
24 | HTML5 Boilerplate is a starting point, not a destination.
25 |
26 | ## Basic structure
27 |
28 | A basic HTML5 Boilerplate site initially looks something like this:
29 |
30 | ```
31 | .
32 | ├── css
33 | │ ├── main.css
34 | │ └── normalize.css
35 | ├── doc
36 | ├── img
37 | ├── js
38 | │ ├── main.js
39 | │ ├── plugins.js
40 | │ └── vendor
41 | │ ├── jquery.min.js
42 | │ └── modernizr.min.js
43 | ├── .editorconfig
44 | ├── .htaccess
45 | ├── 404.html
46 | ├── browserconfig.xml
47 | ├── favicon.ico
48 | ├── humans.txt
49 | ├── icon.png
50 | ├── index.html
51 | ├── robots.txt
52 | ├── site.webmanifest
53 | ├── tile.png
54 | └── tile-wide.png
55 | ```
56 |
57 | What follows is a general overview of each major part and how to use them.
58 |
59 | ### css
60 |
61 | This directory should contain all your project's CSS files. It includes some
62 | initial CSS to help get you started from a solid foundation. [About the
63 | CSS](css.md).
64 |
65 | ### doc
66 |
67 | This directory contains all the HTML5 Boilerplate documentation. You can use it
68 | as the location and basis for your own project's documentation.
69 |
70 | ### js
71 |
72 | This directory should contain all your project's JS files. Libraries, plugins,
73 | and custom code can all be included here. It includes some initial JS to help
74 | get you started. [About the JavaScript](js.md).
75 |
76 | ### .htaccess
77 |
78 | The default web server configs are for Apache. For more information, please
79 | refer to the [Apache Server Configs
80 | repository](https://github.com/h5bp/server-configs-apache).
81 |
82 | Host your site on a server other than Apache? You're likely to find the
83 | corresponding server configs project listed in our [Server Configs
84 | ](https://github.com/h5bp/server-configs/blob/master/README.md) repository.
85 |
86 | ### 404.html
87 |
88 | A helpful custom 404 to get you started.
89 |
90 | ### browserconfig.xml
91 |
92 | This file contains all settings regarding custom tiles for IE11 and Edge.
93 |
94 | For more info on this topic, please refer to
95 | [MSDN](https://msdn.microsoft.com/library/dn455106.aspx).
96 |
97 | ### .editorconfig
98 |
99 | The `.editorconfig` file is provided in order to encourage and help you and
100 | your team to maintain consistent coding styles between different
101 | editors and IDEs. [Read more about the `.editorconfig` file](misc.md#editorconfig).
102 |
103 | ### index.html
104 |
105 | This is the default HTML skeleton that should form the basis of all pages on
106 | your site. If you are using a server-side templating framework, then you will
107 | need to integrate this starting HTML with your setup.
108 |
109 | Make sure that you update the URLs for the referenced CSS and JavaScript if you
110 | modify the directory structure at all.
111 |
112 | If you are using Google Universal Analytics, make sure that you edit the
113 | corresponding snippet at the bottom to include your analytics ID.
114 |
115 | ### humans.txt
116 |
117 | Edit this file to include the team that worked on your site/app, and the
118 | technology powering it.
119 |
120 | ### robots.txt
121 |
122 | Edit this file to include any pages you need hidden from search engines.
123 |
124 | ### Icons
125 |
126 | Replace the default `favicon.ico`, `tile.png`, `tile-wide.png` and Apple
127 | Touch Icon with your own.
128 |
129 | If you want to use different Apple Touch Icons for different resolutions please
130 | refer to the [according documentation](extend.md#apple-touch-icons).
131 |
--------------------------------------------------------------------------------
/docs/desc/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/favicon-16x16.png
--------------------------------------------------------------------------------
/docs/desc/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/favicon-32x32.png
--------------------------------------------------------------------------------
/docs/desc/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/favicon.ico
--------------------------------------------------------------------------------
/docs/desc/humans.txt:
--------------------------------------------------------------------------------
1 | # humanstxt.org/
2 | # The humans responsible & technology colophon
3 |
4 | # TEAM
5 |
6 | -- --
7 |
8 | # THANKS
9 |
10 |
11 |
12 | # TECHNOLOGY COLOPHON
13 |
14 | CSS3, HTML5
15 | Apache Server Configs, jQuery, Modernizr, Normalize.css
16 |
--------------------------------------------------------------------------------
/docs/desc/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/icon.png
--------------------------------------------------------------------------------
/docs/desc/img/.gitignore:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/img/.gitignore
--------------------------------------------------------------------------------
/docs/desc/img/load.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/desc/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/img/logo.png
--------------------------------------------------------------------------------
/docs/desc/img/logo.svg:
--------------------------------------------------------------------------------
1 |
66 |
--------------------------------------------------------------------------------
/docs/desc/index.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 |
28 |
29 |
30 |
\n\t\t"),listener()}function listener(){$.all(".sidebar ul>li>a",function(e){$.on(e,"click",function(e){if(e.preventDefault(),config.hasOwnProperty("paths")){var t=Object.keys(dataPaths).indexOf(e.target.innerHTML);window.location="#"+t,load(Object.values(dataPaths)[t])}else window.location="#"+("a"!=e.target.tagName.toLowerCase()?e.target.parentNode.href.split("/").slice(-1)[0]:e.target.href.split("/").slice(-1)[0]),load("a"!=e.target.tagName.toLowerCase()?e.target.parentNode.href:e.target.href);listener()})})}function render(e){var t=new showdown.Converter;fetch(e).then(function(e){return e.text()}).then(function(e){var n=t.makeHtml(e);$.html(".content",n)})}var $=new DisplayJS(window);$.on(".copyright","click",function(){window.location="https://kiwidocs.js.org"}),$.on(".arrow","click",function(){$.toggleClass(".sidebar","hovered")}),$.on(".sidebar","click",function(){$.toggleClass(".sidebar","hovered")});var configLoaded=!1,config=[],dataPaths=[];load(),listener();
2 |
--------------------------------------------------------------------------------
/docs/desc/js/plugins.js:
--------------------------------------------------------------------------------
1 | !function(){for(var e,n=function(){},o=["assert","clear","count","debug","dir","dirxml","error","exception","group","groupCollapsed","groupEnd","info","log","markTimeline","profile","profileEnd","table","time","timeEnd","timeline","timelineEnd","timeStamp","trace","warn"],i=o.length,r=window.console=window.console||{};i--;)e=o[i],r[e]||(r[e]=n)}();
--------------------------------------------------------------------------------
/docs/desc/mstile-150x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/mstile-150x150.png
--------------------------------------------------------------------------------
/docs/desc/robots.txt:
--------------------------------------------------------------------------------
1 | # www.robotstxt.org/
2 |
3 | # Allow crawling of all content
4 | User-agent: *
5 | Disallow:
6 |
--------------------------------------------------------------------------------
/docs/desc/safari-pinned-tab.svg:
--------------------------------------------------------------------------------
1 |
2 |
4 |
82 |
--------------------------------------------------------------------------------
/docs/desc/site.webmanifest:
--------------------------------------------------------------------------------
1 | {
2 | "icons": [{
3 | "src": "icon.png",
4 | "sizes": "192x192",
5 | "type": "image/png"
6 | }],
7 | "start_url": "/"
8 | }
9 |
--------------------------------------------------------------------------------
/docs/desc/tile-wide.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/tile-wide.png
--------------------------------------------------------------------------------
/docs/desc/tile.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/desc/tile.png
--------------------------------------------------------------------------------
/docs/doc/TOC.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/)
2 |
3 | ## Getting started
4 |
5 | * [Usage](usage.md) — Overview of the project contents.
6 | * [FAQ](faq.md) — Frequently asked questions along with their answers.
7 |
8 | ## HTML5 Boilerplate core
9 |
10 | * [HTML](html.md) — Guide to the default HTML.
11 | * [CSS](css.md) — Guide to the default CSS.
12 | * [JavaScript](js.md) — Guide to the default JavaScript.
13 | * [Everything else](misc.md).
14 |
15 | ## Development
16 |
17 | * [Extending and customizing HTML5 Boilerplate](extend.md) — Going further
18 | with the boilerplate.
19 |
20 | ## Related projects
21 |
22 | The [H5BP organization](https://github.com/h5bp) maintains several projects
23 | that complement HTML5 Boilerplate, projects that can help you improve different
24 | aspects of your website/web app (e.g.: the performance, security, etc.).
25 |
26 | * [Server Configs](https://github.com/h5bp/server-configs) — Fast and
27 | smart configurations for web servers such as Apache and Nginx.
28 | * [Apache](https://github.com/h5bp/server-configs-apache)
29 | * [Google App Engine (GAE)](https://github.com/h5bp/server-configs-gae)
30 | * [Internet Information Services (IIS)](https://github.com/h5bp/server-configs-iis)
31 | * [lighttpd](https://github.com/h5bp/server-configs-lighttpd)
32 | * [Nginx](https://github.com/h5bp/server-configs-nginx)
33 | * [Node.js](https://github.com/h5bp/server-configs-node)
34 | * [Ant Build Script](https://github.com/h5bp/ant-build-script) — Apache
35 | Ant based build script.
36 |
--------------------------------------------------------------------------------
/docs/doc/faq.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # Frequently asked questions
5 |
6 | * [Why is the Google Analytics code at the bottom? Google recommends it be
7 | placed in the ``.](#why-is-the-google-analytics-code-at-the-bottom-google-recommends-it-be-placed-in-the-head)
8 | * [How can I integrate Bootstrap with HTML5
9 | Boilerplate?](#how-can-i-integrate-bootstrap-with-html5-boilerplate)
10 | * [Do I need to upgrade my site each time a new version of HTML5 Boilerplate is
11 | released?](#do-i-need-to-upgrade-my-site-each-time-a-new-version-of-html5-boilerplate-is-released)
12 | * [Where can I get help with support
13 | questions?](#where-can-i-get-help-with-support-questions)
14 |
15 | ---
16 |
17 | ### Why is the Google Analytics code at the bottom? Google recommends it be placed in the ``.
18 |
19 | The main advantage of placing it in the `` is that you will track the
20 | user's `pageview` even if they leave the page before it has been fully loaded.
21 |
22 | Here's a handy quote from [Mathias Bynens](https://mathiasbynens.be/notes/async-analytics-snippet#comment-50) about our placement choice.
23 | >I should point out that it’s Google — not me — recommending to place this
24 | script before all other scripts in the document. The only real advantage is to
25 | catch a pageView call if your page fails to load completely (for example, if
26 | the user aborts loading, or quickly closes the page, etc.). Personally, I
27 | wouldn’t count that as a page view, so I actually prefer to place this script
28 | at the bottom, after all other scripts. This keeps all the scripts together and
29 | reinforces that scripts at the bottom are the right move. (Usually I
30 | concatenate and minify all my scripts into one .js file — the GA snippet being
31 | the suffix.)
32 |
33 | ### How can I integrate [Bootstrap](https://getbootstrap.com/) with HTML5 Boilerplate?
34 |
35 | Here's Nicolas Gallagher writing about how [HTML5 Boilerplate and Bootstrap complement each
36 | other](https://www.quora.com/Is-Bootstrap-a-complement-or-an-alternative-to-HTML5-Boilerplate-or-viceversa/answer/Nicolas-Gallagher).
37 |
38 | ### Do I need to upgrade my site each time a new version of HTML5 Boilerplate is released?
39 |
40 | No, same as you don't normally replace the foundation of a house once it
41 | was built. However, there is nothing stopping you from trying to work in the
42 | latest changes, but you'll have to assess the costs/benefits of doing so.
43 |
44 | ### Where can I get help with support questions?
45 |
46 | Please ask for help on
47 | [StackOverflow](https://stackoverflow.com/questions/tagged/html5boilerplate).
48 |
--------------------------------------------------------------------------------
/docs/doc/js.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # The JavaScript
5 |
6 | Information about the default JavaScript included in the project.
7 |
8 | ## main.js
9 |
10 | This file can be used to contain or reference your site/app JavaScript code.
11 | If you're working on something more advanced you might replace this file
12 | entirely. That's cool.
13 |
14 | ## plugins.js
15 |
16 | This file can be used to contain all your plugins, such as jQuery plugins and
17 | other 3rd party scripts for a simple site.
18 |
19 | One approach is to put jQuery plugins inside of a `(function($){ ...
20 | })(jQuery);` closure to make sure they're in the jQuery namespace safety
21 | blanket. Read more about [jQuery plugin
22 | authoring](https://learn.jquery.com/plugins/#Getting_Started).
23 |
24 | By default the `plugins.js` file contains a small script to avoid `console`
25 | errors in browsers that lack a `console`. The script will make sure that, if
26 | a console method isn't available, that method will have the value of empty
27 | function, thus, preventing the browser from throwing an error.
28 |
29 | ## vendor
30 |
31 | This directory can be used to contain all 3rd party library code.
32 |
33 | Minified versions of the latest jQuery and Modernizr libraries are included by
34 | default. You may wish to create your own [custom Modernizr
35 | build with the online builder](https://www.modernizr.com/download/) or [command
36 | line tool](https://modernizr.com/docs#command-line-config).
37 |
--------------------------------------------------------------------------------
/docs/doc/misc.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # Miscellaneous
5 |
6 | * [.gitignore](#gitignore)
7 | * [.editorconfig](#editorconfig)
8 | * [Server Configuration](#server-configuration)
9 | * [robots.txt](#robotstxt)
10 | * [browserconfig.xml](#browserconfigxml)
11 |
12 | --
13 |
14 | ## .gitignore
15 |
16 | HTML5 Boilerplate includes a basic project-level `.gitignore`. This should
17 | primarily be used to avoid certain project-level files and directories from
18 | being kept under source control. Different development-environments will
19 | benefit from different collections of ignores.
20 |
21 | OS-specific and editor-specific files should be ignored using a "global
22 | ignore" that applies to all repositories on your system.
23 |
24 | For example, add the following to your `~/.gitconfig`, where the `.gitignore`
25 | in your HOME directory contains the files and directories you'd like to
26 | globally ignore:
27 |
28 | ```gitignore
29 | [core]
30 | excludesfile = ~/.gitignore
31 | ```
32 |
33 | * More on global ignores: https://help.github.com/articles/ignoring-files/
34 | * Comprehensive set of ignores on GitHub: https://github.com/github/gitignore
35 |
36 |
37 | ## .editorconfig
38 |
39 | The `.editorconfig` file is provided in order to encourage and help you and
40 | your team define and maintain consistent coding styles between different
41 | editors and IDEs.
42 |
43 | By default, `.editorconfig` includes some basic
44 | [properties](http://editorconfig.org/#supported-properties) that reflect the
45 | coding styles from the files provided by default, but you can easily change
46 | them to better suit your needs.
47 |
48 | In order for your editor/IDE to apply the
49 | [properties](http://editorconfig.org/#supported-properties) from the
50 | `.editorconfig` file, you may need to [install a
51 | plugin]( http://editorconfig.org/#download).
52 |
53 | __N.B.__ If you aren't using the server configurations provided by HTML5
54 | Boilerplate, we highly encourage you to configure your server to block
55 | access to `.editorconfig` files, as they can disclose sensitive information!
56 |
57 | For more details, please refer to the [EditorConfig
58 | project](http://editorconfig.org/).
59 |
60 |
61 | ## Server Configuration
62 |
63 | H5BP includes a [`.htaccess`](#htaccess) file for the [Apache HTTP
64 | server](https://httpd.apache.org/docs/). If you are not using Apache
65 | as your web server, then you are encouraged to download a
66 | [server configuration](https://github.com/h5bp/server-configs) that
67 | corresponds to your web server and environment.
68 |
69 | A `.htaccess` (hypertext access) file is an [Apache HTTP server
70 | configuration file](https://github.com/h5bp/server-configs-apache).
71 | The `.htaccess` file is mostly used for:
72 |
73 | * Rewriting URLs
74 | * Controlling cache
75 | * Authentication
76 | * Server-side includes
77 | * Redirects
78 | * Gzipping
79 |
80 | If you have access to the main server configuration file (usually called
81 | `httpd.conf`), you should add the logic from the `.htaccess` file in, for
82 | example, a section in the main configuration file. This is usually
83 | the recommended way, as using .htaccess files slows down Apache!
84 |
85 | To enable Apache modules locally, please see:
86 | https://github.com/h5bp/server-configs-apache/wiki/How-to-enable-Apache-modules.
87 |
88 | In the repo the `.htaccess` is used for:
89 |
90 | * Allowing cross-origin access to web fonts
91 | * CORS header for images when browsers request it
92 | * Enable `404.html` as 404 error document
93 | * Making the website experience better for IE users better
94 | * Media UTF-8 as character encoding for `text/html` and `text/plain`
95 | * Enabling the rewrite URLs engine
96 | * Forcing or removing the `www.` at the begin of a URL
97 | * It blocks access to directories without a default document
98 | * It blocks access to files that can expose sensitive information.
99 | * It reduces MIME type security risks
100 | * It forces compressing (gzipping)
101 | * It tells the browser whether they should request a specific file from the
102 | server or whether they should grab it from the browser's cache
103 |
104 | When using `.htaccess` we recommend reading all inline comments (the rules after
105 | a `#`) in the file once. There is a bunch of optional stuff in it.
106 |
107 | If you want to know more about the `.htaccess` file check out the
108 | [Apache HTTP server docs](https://httpd.apache.org/docs/) or more
109 | specifically the [htaccess
110 | section](https://httpd.apache.org/docs/current/howto/htaccess.html).
111 |
112 | Notice that the original repo for the `.htaccess` file is [this
113 | one](https://github.com/h5bp/server-configs-apache).
114 |
115 |
116 | ## robots.txt
117 |
118 | The `robots.txt` file is used to give instructions to web robots on what can
119 | be crawled from the website.
120 |
121 | By default, the file provided by this project includes the next two lines:
122 |
123 | * `User-agent: *` - the following rules apply to all web robots
124 | * `Disallow:` - everything on the website is allowed to be crawled
125 |
126 | If you want to disallow certain pages you will need to specify the path in a
127 | `Disallow` directive (e.g.: `Disallow: /path`) or, if you want to disallow
128 | crawling of all content, use `Disallow: /`.
129 |
130 | The `/robots.txt` file is not intended for access control, so don't try to
131 | use it as such. Think of it as a "No Entry" sign, rather than a locked door.
132 | URLs disallowed by the `robots.txt` file might still be indexed without being
133 | crawled, and the content from within the `robots.txt` file can be viewed by
134 | anyone, potentially disclosing the location of your private content! So, if
135 | you want to block access to private content, use proper authentication instead.
136 |
137 | For more information about `robots.txt`, please see:
138 |
139 | * [robotstxt.org](http://www.robotstxt.org/)
140 | * [How Google handles the `robots.txt` file](https://developers.google.com/webmasters/control-crawl-index/docs/robots_txt)
141 |
142 |
143 | ## browserconfig.xml
144 |
145 | The `browserconfig.xml` file is used to customize the tile displayed when users
146 | pin your site to the Windows 8.1 start screen. In there you can define custom
147 | tile colors, custom images or even [live tiles](https://msdn.microsoft.com/library/dn455106.aspx#CreatingLiveTiles).
148 |
149 | By default, the file points to 2 placeholder tile images:
150 |
151 | * `tile.png` (558x558px): used for `Small`, `Medium` and `Large` tiles.
152 | This image resizes automatically when necessary.
153 | * `tile-wide.png` (558x270px): user for `Wide` tiles.
154 |
155 | Notice that IE11 uses the same images when adding a site to the `favorites`.
156 |
157 | For more in-depth information about the `browserconfig.xml` file, please
158 | see [MSDN](https://msdn.microsoft.com/library/dn320426.aspx).
159 |
--------------------------------------------------------------------------------
/docs/doc/usage.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # Usage
5 |
6 | The most basic usage of HTML5 Boilerplate is to create a static site or simple
7 | app. Once you've downloaded or cloned the project, that process looks something
8 | like this:
9 |
10 | 1. Set up the basic structure of the site.
11 | 2. Add some content, style, and functionality.
12 | 3. Run your site locally to see how it looks.
13 | 4. Deploy your site.
14 |
15 | Cool, right? _It is_. That said, the smart defaults, baseline elements, default
16 | attribute values and various other utilities that HTML5 Boilerplate offers can
17 | serve as the foundation for whatever you're interested in building.
18 |
19 | Even the basic use-case of a simple static site can be enhanced by manipulating
20 | the code through an automated build process. Moving up in complexity HTML5
21 | Boilerplate can be be integrated with whatever front-end framework, CMS or
22 | e-commerce platform you're working with. Mix-and-match to your heart's content.
23 | Use what you need (toss it in a blender if you need to) and discard the rest.
24 | HTML5 Boilerplate is a starting point, not a destination.
25 |
26 | ## Basic structure
27 |
28 | A basic HTML5 Boilerplate site initially looks something like this:
29 |
30 | ```
31 | .
32 | ├── css
33 | │ ├── main.css
34 | │ └── normalize.css
35 | ├── doc
36 | ├── img
37 | ├── js
38 | │ ├── main.js
39 | │ ├── plugins.js
40 | │ └── vendor
41 | │ ├── jquery.min.js
42 | │ └── modernizr.min.js
43 | ├── .editorconfig
44 | ├── .htaccess
45 | ├── 404.html
46 | ├── browserconfig.xml
47 | ├── favicon.ico
48 | ├── humans.txt
49 | ├── icon.png
50 | ├── index.html
51 | ├── robots.txt
52 | ├── site.webmanifest
53 | ├── tile.png
54 | └── tile-wide.png
55 | ```
56 |
57 | What follows is a general overview of each major part and how to use them.
58 |
59 | ### css
60 |
61 | This directory should contain all your project's CSS files. It includes some
62 | initial CSS to help get you started from a solid foundation. [About the
63 | CSS](css.md).
64 |
65 | ### doc
66 |
67 | This directory contains all the HTML5 Boilerplate documentation. You can use it
68 | as the location and basis for your own project's documentation.
69 |
70 | ### js
71 |
72 | This directory should contain all your project's JS files. Libraries, plugins,
73 | and custom code can all be included here. It includes some initial JS to help
74 | get you started. [About the JavaScript](js.md).
75 |
76 | ### .htaccess
77 |
78 | The default web server configs are for Apache. For more information, please
79 | refer to the [Apache Server Configs
80 | repository](https://github.com/h5bp/server-configs-apache).
81 |
82 | Host your site on a server other than Apache? You're likely to find the
83 | corresponding server configs project listed in our [Server Configs
84 | ](https://github.com/h5bp/server-configs/blob/master/README.md) repository.
85 |
86 | ### 404.html
87 |
88 | A helpful custom 404 to get you started.
89 |
90 | ### browserconfig.xml
91 |
92 | This file contains all settings regarding custom tiles for IE11 and Edge.
93 |
94 | For more info on this topic, please refer to
95 | [MSDN](https://msdn.microsoft.com/library/dn455106.aspx).
96 |
97 | ### .editorconfig
98 |
99 | The `.editorconfig` file is provided in order to encourage and help you and
100 | your team to maintain consistent coding styles between different
101 | editors and IDEs. [Read more about the `.editorconfig` file](misc.md#editorconfig).
102 |
103 | ### index.html
104 |
105 | This is the default HTML skeleton that should form the basis of all pages on
106 | your site. If you are using a server-side templating framework, then you will
107 | need to integrate this starting HTML with your setup.
108 |
109 | Make sure that you update the URLs for the referenced CSS and JavaScript if you
110 | modify the directory structure at all.
111 |
112 | If you are using Google Universal Analytics, make sure that you edit the
113 | corresponding snippet at the bottom to include your analytics ID.
114 |
115 | ### humans.txt
116 |
117 | Edit this file to include the team that worked on your site/app, and the
118 | technology powering it.
119 |
120 | ### robots.txt
121 |
122 | Edit this file to include any pages you need hidden from search engines.
123 |
124 | ### Icons
125 |
126 | Replace the default `favicon.ico`, `tile.png`, `tile-wide.png` and Apple
127 | Touch Icon with your own.
128 |
129 | If you want to use different Apple Touch Icons for different resolutions please
130 | refer to the [according documentation](extend.md#apple-touch-icons).
131 |
--------------------------------------------------------------------------------
/docs/docs/.editorconfig:
--------------------------------------------------------------------------------
1 | # editorconfig.org
2 |
3 | root = true
4 |
5 | [*]
6 | charset = utf-8
7 | indent_size = 4
8 | indent_style = space
9 | insert_final_newline = true
10 | trim_trailing_whitespace = true
11 |
12 | [*.md]
13 | trim_trailing_whitespace = false
14 |
--------------------------------------------------------------------------------
/docs/docs/.gitattributes:
--------------------------------------------------------------------------------
1 | ## GITATTRIBUTES FOR WEB PROJECTS
2 | #
3 | # These settings are for any web project.
4 | #
5 | # Details per file setting:
6 | # text These files should be normalized (i.e. convert CRLF to LF).
7 | # binary These files are binary and should be left untouched.
8 | #
9 | # Note that binary is a macro for -text -diff.
10 | ######################################################################
11 |
12 | ## AUTO-DETECT
13 | ## Handle line endings automatically for files detected as
14 | ## text and leave all files detected as binary untouched.
15 | ## This will handle all files NOT defined below.
16 | * text=auto
17 |
18 | ## SOURCE CODE
19 | *.bat text eol=crlf
20 | *.coffee text
21 | *.css text
22 | *.htm text
23 | *.html text
24 | *.inc text
25 | *.ini text
26 | *.js text
27 | *.json text
28 | *.jsx text
29 | *.less text
30 | *.od text
31 | *.onlydata text
32 | *.php text
33 | *.pl text
34 | *.py text
35 | *.rb text
36 | *.sass text
37 | *.scm text
38 | *.scss text
39 | *.sh text eol=lf
40 | *.sql text
41 | *.styl text
42 | *.tag text
43 | *.ts text
44 | *.tsx text
45 | *.xml text
46 | *.xhtml text
47 |
48 | ## DOCKER
49 | *.dockerignore text
50 | Dockerfile text
51 |
52 | ## DOCUMENTATION
53 | *.markdown text
54 | *.md text
55 | *.mdwn text
56 | *.mdown text
57 | *.mkd text
58 | *.mkdn text
59 | *.mdtxt text
60 | *.mdtext text
61 | *.txt text
62 | AUTHORS text
63 | CHANGELOG text
64 | CHANGES text
65 | CONTRIBUTING text
66 | COPYING text
67 | copyright text
68 | *COPYRIGHT* text
69 | INSTALL text
70 | license text
71 | LICENSE text
72 | NEWS text
73 | readme text
74 | *README* text
75 | TODO text
76 |
77 | ## TEMPLATES
78 | *.dot text
79 | *.ejs text
80 | *.haml text
81 | *.handlebars text
82 | *.hbs text
83 | *.hbt text
84 | *.jade text
85 | *.latte text
86 | *.mustache text
87 | *.njk text
88 | *.phtml text
89 | *.tmpl text
90 | *.tpl text
91 | *.twig text
92 |
93 | ## LINTERS
94 | .csslintrc text
95 | .eslintrc text
96 | .htmlhintrc text
97 | .jscsrc text
98 | .jshintrc text
99 | .jshintignore text
100 | .stylelintrc text
101 |
102 | ## CONFIGS
103 | *.bowerrc text
104 | *.cnf text
105 | *.conf text
106 | *.config text
107 | .browserslistrc text
108 | .editorconfig text
109 | .gitattributes text
110 | .gitconfig text
111 | .gitignore text
112 | .htaccess text
113 | *.npmignore text
114 | *.yaml text
115 | *.yml text
116 | browserslist text
117 | Makefile text
118 | makefile text
119 |
120 | ## HEROKU
121 | Procfile text
122 | .slugignore text
123 |
124 | ## GRAPHICS
125 | *.ai binary
126 | *.bmp binary
127 | *.eps binary
128 | *.gif binary
129 | *.ico binary
130 | *.jng binary
131 | *.jp2 binary
132 | *.jpg binary
133 | *.jpeg binary
134 | *.jpx binary
135 | *.jxr binary
136 | *.pdf binary
137 | *.png binary
138 | *.psb binary
139 | *.psd binary
140 | *.svg text
141 | *.svgz binary
142 | *.tif binary
143 | *.tiff binary
144 | *.wbmp binary
145 | *.webp binary
146 |
147 | ## AUDIO
148 | *.kar binary
149 | *.m4a binary
150 | *.mid binary
151 | *.midi binary
152 | *.mp3 binary
153 | *.ogg binary
154 | *.ra binary
155 |
156 | ## VIDEO
157 | *.3gpp binary
158 | *.3gp binary
159 | *.as binary
160 | *.asf binary
161 | *.asx binary
162 | *.fla binary
163 | *.flv binary
164 | *.m4v binary
165 | *.mng binary
166 | *.mov binary
167 | *.mp4 binary
168 | *.mpeg binary
169 | *.mpg binary
170 | *.ogv binary
171 | *.swc binary
172 | *.swf binary
173 | *.webm binary
174 |
175 | ## ARCHIVES
176 | *.7z binary
177 | *.gz binary
178 | *.jar binary
179 | *.rar binary
180 | *.tar binary
181 | *.zip binary
182 |
183 | ## FONTS
184 | *.ttf binary
185 | *.eot binary
186 | *.otf binary
187 | *.woff binary
188 | *.woff2 binary
189 |
190 | ## EXECUTABLES
191 | *.exe binary
192 | *.pyc binary
193 |
--------------------------------------------------------------------------------
/docs/docs/.gitignore:
--------------------------------------------------------------------------------
1 | # Include your project-specific ignores in this file
2 | # Read about how to use .gitignore: https://help.github.com/articles/ignoring-files
3 | # Useful .gitignore templates: https://github.com/github/gitignore
4 |
--------------------------------------------------------------------------------
/docs/docs/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Page Not Found
6 |
7 |
54 |
55 |
56 |
Page Not Found
57 |
Sorry, but the page you were trying to view does not exist.
58 |
59 |
60 |
61 |
--------------------------------------------------------------------------------
/docs/docs/LICENSE.txt:
--------------------------------------------------------------------------------
1 | Copyright (c) HTML5 Boilerplate
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of
4 | this software and associated documentation files (the "Software"), to deal in
5 | the Software without restriction, including without limitation the rights to
6 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7 | of the Software, and to permit persons to whom the Software is furnished to do
8 | so, subject to the following conditions:
9 |
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 |
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19 | SOFTWARE.
20 |
--------------------------------------------------------------------------------
/docs/docs/android-chrome-192x192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/docs/android-chrome-192x192.png
--------------------------------------------------------------------------------
/docs/docs/android-chrome-512x512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/docs/android-chrome-512x512.png
--------------------------------------------------------------------------------
/docs/docs/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/docs/apple-touch-icon.png
--------------------------------------------------------------------------------
/docs/docs/browserconfig.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | #da532c
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/docs/docs/config.json:
--------------------------------------------------------------------------------
1 | [{
2 | "type": "github",
3 | "title": "TheoremJS",
4 | "url": "https://github.com/arguiot/TheoremJS/wiki",
5 | "logo": "https://theorem.js.org/img/TheoremJS.svg",
6 | "copyright": "Arthur Guiot",
7 | "analytics": "UA-109503398-4"
8 | }]
9 |
--------------------------------------------------------------------------------
/docs/docs/css/main.css:
--------------------------------------------------------------------------------
1 | /*! HTML5 Boilerplate v6.0.1 | MIT License | https://html5boilerplate.com/ */html{color:#222;font-size:1em;line-height:1.4}::-moz-selection{background:#b3d4fc;text-shadow:none}::selection{background:#b3d4fc;text-shadow:none}hr{display:block;height:1px;border:0;border-top:1px solid #ccc;margin:1em 0;padding:0}audio,canvas,iframe,img,svg,video{vertical-align:middle}fieldset{border:0;margin:0;padding:0}textarea{resize:vertical}.browserupgrade{margin:0.2em 0;background:#ccc;color:#000;padding:0.2em 0}body{overflow-x:hidden}.sidebar{position:fixed;top:0;left:-290px;width:300px;height:100vh;background:transparent;-webkit-transition:all 500ms ease-in-out;transition:all 500ms ease-in-out;overflow-x:hidden;overflow-y:hidden;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-size:16px;line-height:1.5;word-wrap:break-word;padding:20px}@media (min-width: 500px){.sidebar:hover{position:fixed;left:0px;width:300px;background:#333;z-index:10;overflow-y:scroll}.sidebar:hover+.arrow{-webkit-transition:all 500ms ease-in-out;transition:all 500ms ease-in-out;left:300px;background:transparent}}.hovered{position:fixed;left:0px;width:300px;background:#333;z-index:10;overflow-y:scroll}.sidebar ul>li{color:white}.sidebar ul>li>a{color:white;text-decoration:none}.sidebar ul>li>a:hover{cursor:pointer;text-decoration:underline}.anchor{display:none}.arrow{width:50px;height:50px;background:#333;color:white;position:fixed;left:0;top:calc(50vh - 25px);z-index:-100;text-align:center;line-height:50px}.hovered+arrow{-webkit-transition:all 500ms ease-in-out;transition:all 500ms ease-in-out;left:300px;background:transparent}.copyright{font-family:'Roboto', sans-serif;width:100vw;text-align:center;color:#616161;margin-bottom:30px}.copyright:hover{text-decoration:underline;cursor:pointer}.copyright-side{font-family:'Roboto', sans-serif;color:#616161;margin-bottom:30px}.title{width:100vw;text-align:center;height:80px;position:fixed;top:0;font-weight:normal;font-size:32px;line-height:80px;word-wrap:break-word;font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";background:#fff;border-bottom:1px solid #eee}.img{width:150px;max-height:150px}.content{width:calc(90vw - 100px);max-width:800px;margin:0 auto;margin-top:80px;padding:50px;word-wrap:break-word}.hidden{display:none !important}.visuallyhidden{border:0;clip:rect(0 0 0 0);-webkit-clip-path:inset(50%);clip-path:inset(50%);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px;white-space:nowrap}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;-webkit-clip-path:none;clip-path:none;height:auto;margin:0;overflow:visible;position:static;width:auto;white-space:inherit}.invisible{visibility:hidden}.clearfix:before,.clearfix:after{content:" ";display:table}.clearfix:after{clear:both}@media print{*,*:before,*:after{background:transparent !important;color:#000 !important;-webkit-box-shadow:none !important;box-shadow:none !important;text-shadow:none !important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="#"]:after,a[href^="javascript:"]:after{content:""}pre{white-space:pre-wrap !important}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}}
2 |
--------------------------------------------------------------------------------
/docs/docs/css/normalize.css:
--------------------------------------------------------------------------------
1 | /*! normalize.css v7.0.0 | MIT License | github.com/necolas/normalize.css */html{line-height:1.15;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,footer,header,nav,section{display:block}h1{font-size:2em;margin:0.67em 0}figcaption,figure,main{display:block}figure{margin:1em 40px}hr{-webkit-box-sizing:content-box;box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace, monospace;font-size:1em}a{background-color:transparent;-webkit-text-decoration-skip:objects}abbr[title]{border-bottom:none;text-decoration:underline;-webkit-text-decoration:underline dotted;text-decoration:underline dotted}b,strong{font-weight:inherit}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace, monospace;font-size:1em}dfn{font-style:italic}mark{background-color:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-0.25em}sup{top:-0.5em}audio,video{display:inline-block}audio:not([controls]){display:none;height:0}img{border-style:none}svg:not(:root){overflow:hidden}button,input,optgroup,select,textarea{font-family:sans-serif;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}button,html [type="button"],[type="reset"],[type="submit"]{-webkit-appearance:button}button::-moz-focus-inner,[type="button"]::-moz-focus-inner,[type="reset"]::-moz-focus-inner,[type="submit"]::-moz-focus-inner{border-style:none;padding:0}button:-moz-focusring,[type="button"]:-moz-focusring,[type="reset"]:-moz-focusring,[type="submit"]:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:0.35em 0.75em 0.625em}legend{-webkit-box-sizing:border-box;box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{display:inline-block;vertical-align:baseline}textarea{overflow:auto}[type="checkbox"],[type="radio"]{-webkit-box-sizing:border-box;box-sizing:border-box;padding:0}[type="number"]::-webkit-inner-spin-button,[type="number"]::-webkit-outer-spin-button{height:auto}[type="search"]{-webkit-appearance:textfield;outline-offset:-2px}[type="search"]::-webkit-search-cancel-button,[type="search"]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details,menu{display:block}summary{display:list-item}canvas{display:inline-block}template{display:none}[hidden]{display:none}
2 |
--------------------------------------------------------------------------------
/docs/docs/doc/TOC.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/)
2 |
3 | ## Getting started
4 |
5 | * [Usage](usage.md) — Overview of the project contents.
6 | * [FAQ](faq.md) — Frequently asked questions along with their answers.
7 |
8 | ## HTML5 Boilerplate core
9 |
10 | * [HTML](html.md) — Guide to the default HTML.
11 | * [CSS](css.md) — Guide to the default CSS.
12 | * [JavaScript](js.md) — Guide to the default JavaScript.
13 | * [Everything else](misc.md).
14 |
15 | ## Development
16 |
17 | * [Extending and customizing HTML5 Boilerplate](extend.md) — Going further
18 | with the boilerplate.
19 |
20 | ## Related projects
21 |
22 | The [H5BP organization](https://github.com/h5bp) maintains several projects
23 | that complement HTML5 Boilerplate, projects that can help you improve different
24 | aspects of your website/web app (e.g.: the performance, security, etc.).
25 |
26 | * [Server Configs](https://github.com/h5bp/server-configs) — Fast and
27 | smart configurations for web servers such as Apache and Nginx.
28 | * [Apache](https://github.com/h5bp/server-configs-apache)
29 | * [Google App Engine (GAE)](https://github.com/h5bp/server-configs-gae)
30 | * [Internet Information Services (IIS)](https://github.com/h5bp/server-configs-iis)
31 | * [lighttpd](https://github.com/h5bp/server-configs-lighttpd)
32 | * [Nginx](https://github.com/h5bp/server-configs-nginx)
33 | * [Node.js](https://github.com/h5bp/server-configs-node)
34 | * [Ant Build Script](https://github.com/h5bp/ant-build-script) — Apache
35 | Ant based build script.
36 |
--------------------------------------------------------------------------------
/docs/docs/doc/faq.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # Frequently asked questions
5 |
6 | * [Why is the Google Analytics code at the bottom? Google recommends it be
7 | placed in the ``.](#why-is-the-google-analytics-code-at-the-bottom-google-recommends-it-be-placed-in-the-head)
8 | * [How can I integrate Bootstrap with HTML5
9 | Boilerplate?](#how-can-i-integrate-bootstrap-with-html5-boilerplate)
10 | * [Do I need to upgrade my site each time a new version of HTML5 Boilerplate is
11 | released?](#do-i-need-to-upgrade-my-site-each-time-a-new-version-of-html5-boilerplate-is-released)
12 | * [Where can I get help with support
13 | questions?](#where-can-i-get-help-with-support-questions)
14 |
15 | ---
16 |
17 | ### Why is the Google Analytics code at the bottom? Google recommends it be placed in the ``.
18 |
19 | The main advantage of placing it in the `` is that you will track the
20 | user's `pageview` even if they leave the page before it has been fully loaded.
21 |
22 | Here's a handy quote from [Mathias Bynens](https://mathiasbynens.be/notes/async-analytics-snippet#comment-50) about our placement choice.
23 | >I should point out that it’s Google — not me — recommending to place this
24 | script before all other scripts in the document. The only real advantage is to
25 | catch a pageView call if your page fails to load completely (for example, if
26 | the user aborts loading, or quickly closes the page, etc.). Personally, I
27 | wouldn’t count that as a page view, so I actually prefer to place this script
28 | at the bottom, after all other scripts. This keeps all the scripts together and
29 | reinforces that scripts at the bottom are the right move. (Usually I
30 | concatenate and minify all my scripts into one .js file — the GA snippet being
31 | the suffix.)
32 |
33 | ### How can I integrate [Bootstrap](https://getbootstrap.com/) with HTML5 Boilerplate?
34 |
35 | Here's Nicolas Gallagher writing about how [HTML5 Boilerplate and Bootstrap complement each
36 | other](https://www.quora.com/Is-Bootstrap-a-complement-or-an-alternative-to-HTML5-Boilerplate-or-viceversa/answer/Nicolas-Gallagher).
37 |
38 | ### Do I need to upgrade my site each time a new version of HTML5 Boilerplate is released?
39 |
40 | No, same as you don't normally replace the foundation of a house once it
41 | was built. However, there is nothing stopping you from trying to work in the
42 | latest changes, but you'll have to assess the costs/benefits of doing so.
43 |
44 | ### Where can I get help with support questions?
45 |
46 | Please ask for help on
47 | [StackOverflow](https://stackoverflow.com/questions/tagged/html5boilerplate).
48 |
--------------------------------------------------------------------------------
/docs/docs/doc/js.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # The JavaScript
5 |
6 | Information about the default JavaScript included in the project.
7 |
8 | ## main.js
9 |
10 | This file can be used to contain or reference your site/app JavaScript code.
11 | If you're working on something more advanced you might replace this file
12 | entirely. That's cool.
13 |
14 | ## plugins.js
15 |
16 | This file can be used to contain all your plugins, such as jQuery plugins and
17 | other 3rd party scripts for a simple site.
18 |
19 | One approach is to put jQuery plugins inside of a `(function($){ ...
20 | })(jQuery);` closure to make sure they're in the jQuery namespace safety
21 | blanket. Read more about [jQuery plugin
22 | authoring](https://learn.jquery.com/plugins/#Getting_Started).
23 |
24 | By default the `plugins.js` file contains a small script to avoid `console`
25 | errors in browsers that lack a `console`. The script will make sure that, if
26 | a console method isn't available, that method will have the value of empty
27 | function, thus, preventing the browser from throwing an error.
28 |
29 | ## vendor
30 |
31 | This directory can be used to contain all 3rd party library code.
32 |
33 | Minified versions of the latest jQuery and Modernizr libraries are included by
34 | default. You may wish to create your own [custom Modernizr
35 | build with the online builder](https://www.modernizr.com/download/) or [command
36 | line tool](https://modernizr.com/docs#command-line-config).
37 |
--------------------------------------------------------------------------------
/docs/docs/doc/usage.md:
--------------------------------------------------------------------------------
1 | [HTML5 Boilerplate homepage](https://html5boilerplate.com/) | [Documentation
2 | table of contents](TOC.md)
3 |
4 | # Usage
5 |
6 | The most basic usage of HTML5 Boilerplate is to create a static site or simple
7 | app. Once you've downloaded or cloned the project, that process looks something
8 | like this:
9 |
10 | 1. Set up the basic structure of the site.
11 | 2. Add some content, style, and functionality.
12 | 3. Run your site locally to see how it looks.
13 | 4. Deploy your site.
14 |
15 | Cool, right? _It is_. That said, the smart defaults, baseline elements, default
16 | attribute values and various other utilities that HTML5 Boilerplate offers can
17 | serve as the foundation for whatever you're interested in building.
18 |
19 | Even the basic use-case of a simple static site can be enhanced by manipulating
20 | the code through an automated build process. Moving up in complexity HTML5
21 | Boilerplate can be be integrated with whatever front-end framework, CMS or
22 | e-commerce platform you're working with. Mix-and-match to your heart's content.
23 | Use what you need (toss it in a blender if you need to) and discard the rest.
24 | HTML5 Boilerplate is a starting point, not a destination.
25 |
26 | ## Basic structure
27 |
28 | A basic HTML5 Boilerplate site initially looks something like this:
29 |
30 | ```
31 | .
32 | ├── css
33 | │ ├── main.css
34 | │ └── normalize.css
35 | ├── doc
36 | ├── img
37 | ├── js
38 | │ ├── main.js
39 | │ ├── plugins.js
40 | │ └── vendor
41 | │ ├── jquery.min.js
42 | │ └── modernizr.min.js
43 | ├── .editorconfig
44 | ├── .htaccess
45 | ├── 404.html
46 | ├── browserconfig.xml
47 | ├── favicon.ico
48 | ├── humans.txt
49 | ├── icon.png
50 | ├── index.html
51 | ├── robots.txt
52 | ├── site.webmanifest
53 | ├── tile.png
54 | └── tile-wide.png
55 | ```
56 |
57 | What follows is a general overview of each major part and how to use them.
58 |
59 | ### css
60 |
61 | This directory should contain all your project's CSS files. It includes some
62 | initial CSS to help get you started from a solid foundation. [About the
63 | CSS](css.md).
64 |
65 | ### doc
66 |
67 | This directory contains all the HTML5 Boilerplate documentation. You can use it
68 | as the location and basis for your own project's documentation.
69 |
70 | ### js
71 |
72 | This directory should contain all your project's JS files. Libraries, plugins,
73 | and custom code can all be included here. It includes some initial JS to help
74 | get you started. [About the JavaScript](js.md).
75 |
76 | ### .htaccess
77 |
78 | The default web server configs are for Apache. For more information, please
79 | refer to the [Apache Server Configs
80 | repository](https://github.com/h5bp/server-configs-apache).
81 |
82 | Host your site on a server other than Apache? You're likely to find the
83 | corresponding server configs project listed in our [Server Configs
84 | ](https://github.com/h5bp/server-configs/blob/master/README.md) repository.
85 |
86 | ### 404.html
87 |
88 | A helpful custom 404 to get you started.
89 |
90 | ### browserconfig.xml
91 |
92 | This file contains all settings regarding custom tiles for IE11 and Edge.
93 |
94 | For more info on this topic, please refer to
95 | [MSDN](https://msdn.microsoft.com/library/dn455106.aspx).
96 |
97 | ### .editorconfig
98 |
99 | The `.editorconfig` file is provided in order to encourage and help you and
100 | your team to maintain consistent coding styles between different
101 | editors and IDEs. [Read more about the `.editorconfig` file](misc.md#editorconfig).
102 |
103 | ### index.html
104 |
105 | This is the default HTML skeleton that should form the basis of all pages on
106 | your site. If you are using a server-side templating framework, then you will
107 | need to integrate this starting HTML with your setup.
108 |
109 | Make sure that you update the URLs for the referenced CSS and JavaScript if you
110 | modify the directory structure at all.
111 |
112 | If you are using Google Universal Analytics, make sure that you edit the
113 | corresponding snippet at the bottom to include your analytics ID.
114 |
115 | ### humans.txt
116 |
117 | Edit this file to include the team that worked on your site/app, and the
118 | technology powering it.
119 |
120 | ### robots.txt
121 |
122 | Edit this file to include any pages you need hidden from search engines.
123 |
124 | ### Icons
125 |
126 | Replace the default `favicon.ico`, `tile.png`, `tile-wide.png` and Apple
127 | Touch Icon with your own.
128 |
129 | If you want to use different Apple Touch Icons for different resolutions please
130 | refer to the [according documentation](extend.md#apple-touch-icons).
131 |
--------------------------------------------------------------------------------
/docs/docs/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/docs/favicon-16x16.png
--------------------------------------------------------------------------------
/docs/docs/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/docs/favicon-32x32.png
--------------------------------------------------------------------------------
/docs/docs/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/docs/favicon.ico
--------------------------------------------------------------------------------
/docs/docs/humans.txt:
--------------------------------------------------------------------------------
1 | # humanstxt.org/
2 | # The humans responsible & technology colophon
3 |
4 | # TEAM
5 |
6 | -- --
7 |
8 | # THANKS
9 |
10 |
11 |
12 | # TECHNOLOGY COLOPHON
13 |
14 | CSS3, HTML5
15 | Apache Server Configs, jQuery, Modernizr, Normalize.css
16 |
--------------------------------------------------------------------------------
/docs/docs/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/docs/icon.png
--------------------------------------------------------------------------------
/docs/docs/img/.gitignore:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/docs/img/.gitignore
--------------------------------------------------------------------------------
/docs/docs/img/load.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/docs/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arguiot/TheoremJS/94402cd770a4c9b55d79805ea7cb5ac090d9d3ca/docs/docs/img/logo.png
--------------------------------------------------------------------------------
/docs/docs/img/logo.svg:
--------------------------------------------------------------------------------
1 |
66 |
--------------------------------------------------------------------------------
/docs/docs/index.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 |
28 |
29 |
30 |
44 |