├── LICENSE ├── README.md ├── doctemplate.png ├── documentation.html ├── logo.svg └── style.css /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Carlos Yllobre 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # doctemplate 2 | Doctemplate is a simple one page HTML/CSS documentation template for your projects. As simple as it is. Enjoy it! 3 | 4 | ![Doctemplate](/doctemplate.png) 5 | 6 | ## License 7 | [MIT](https://opensource.org/licenses/MIT) © [Carlos Yllobre](https://iamcharlie.design/) 8 | -------------------------------------------------------------------------------- /doctemplate.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/charlyllo/doctemplate/7d5073f627b90ff983e35ebb09c774e21a0cb20f/doctemplate.png -------------------------------------------------------------------------------- /documentation.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Documentation Template 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 |
24 |
25 | 26 |   Documentation 27 |   yourapp@email.com 28 |
29 |
30 | 31 |
32 |
33 | 34 |
35 | 36 | Introduction 37 | 38 | Supported Versions 39 | About this App 40 | Technology 41 | 42 |
43 | 44 | Getting Started 45 | 46 | Installing the App 47 | Opening the App 48 | 49 |
50 | 51 | Basic Features 52 | 53 | Feature 1 54 | Feature 2 55 | Feature 3 56 | Feature 4 57 | Feature 5 58 | 59 |
60 | 61 | Advanced Features 62 | 63 | Feature A 64 | Feature B 65 | Feature C 66 | Feature C.1 67 | Feature C.2 68 | Feature D 69 | 70 |
71 | 72 | Accesibility 73 | 74 |
75 | 76 | More Info 77 | 78 |
79 | 80 |
81 | 82 |
83 | 84 | 85 | 86 |

Introduction

87 | 88 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 89 | Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor 90 | in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, 91 | sunt in culpa qui officia deserunt mollit anim id est laborum.

92 | 93 |

Supported Versions:

94 | 95 |

App Version 1.0.0. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

96 | 97 |

About this App

98 | 99 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

100 | 101 |

Technology

102 | 103 |

This app is built with Javascript, HTML and CSS.
104 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

105 | 106 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore

107 | 108 |
109 | 110 |

Getting Started

111 | 112 |

This is a sub-header

113 | 114 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 115 | Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor 116 | in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, 117 | sunt in culpa qui officia deserunt mollit anim id est laborum.

118 | 119 |

Important: This line is for an important information.

120 | 121 | 122 |

Install the App

123 | 124 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

125 | 126 |
    127 |
  1. 128 | The first thing you need to do to install this app. 129 |
    2. 130 |
    131 |
  2. 132 | The second thing you need to do to install this app. 133 |
    3. 134 |
    135 |
  3. 136 | The app is installed now. 137 |
    4. 138 |
    139 |
140 | 141 | 142 |

Opening the app

143 | 144 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

145 | 146 |
    147 |
  1. 148 | The first thing you need to do to open this app. 149 |
    2. 150 |
    151 |
  2. 152 | The second thing you need to do to open this app. 153 |
    3. 154 |
    155 |
  3. 156 | The third thing you need to do to open this app. 157 |
    4. 158 |
    159 |
  4. 160 | Open the app and start using it! 161 |
    5. 162 |
    163 |
164 | 165 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

166 | 167 | 168 |
169 | 170 | 171 |

Basic Features

172 | 173 |

Feature 1

174 | 175 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 176 | Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo 177 |

178 | 179 |

Feature 2

180 | 181 |

182 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 183 |

184 | Explanation 1 Lorem ipsum dolor sit amet, consectetur adipiscing elit. 185 |
186 |
187 | Explanation 2 Lorem ipsum dolor sit amet, consectetur adipiscing elit. 188 |
189 |
190 | Explanation 3 Lorem ipsum dolor sit amet, consectetur adipiscing elit. 191 |
192 |
193 | Explanation 4 Lorem ipsum dolor sit amet, consectetur adipiscing elit. 194 |

195 | 196 |

Feature 3

197 | 198 |

199 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 200 |
201 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. 202 |

203 | 204 |

Feature 4

205 | 206 |

207 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 208 |
209 |
210 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. 211 |
212 |
213 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 214 |

215 | 216 | 217 |

Feature 5

218 | 219 |

220 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. 221 |
222 |
223 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 224 |
225 |

226 | 227 | 228 | 229 |

Feature 5

230 | 231 |

232 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. 233 |
234 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 235 |

236 | 237 |
238 | 239 |

Advanced Features

240 | 241 |

Feature A

242 | 243 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 244 | Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor 245 | in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. 246 |
247 |
248 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

249 | 250 | 251 |

Feature B

252 | 253 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 254 |
255 |
256 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

257 | 258 | 259 |

Feature C

260 | 261 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

262 | 263 | 264 |

Feature C.1

265 | 266 |

267 | Lorem ipsum dolor sit amet, consectetur adipiscing elit: 268 |

269 | 270 |
    271 |
  • 272 | Point 1 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 273 |
    274 |
  • 275 | Point 2 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor. 276 |
    • 277 |
    278 |
  • 279 | Point 3 Lorem ipsum dolor sit amet, consectetur adipiscing elit. 280 |
    281 |
282 | 283 |

Feauture C.2

284 | 285 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 286 |
287 |
288 | Important: Please notice that lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 289 |
290 |
291 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. 292 |

293 | 294 | 295 |

Feature D

296 | 297 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 298 | 299 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 300 |
301 |
302 | Lorem ipsum dolor sit amet, consectetur adipiscing elit.

303 | 304 | 305 |
306 | 307 |

Accessibility

308 | 309 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 310 |
311 |
312 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 313 |
314 | Lorem ipsum dolor sit amet, consectetur adipiscing elit.

315 | 316 |

Lorem ipsum dolor sit amet. 317 |
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

318 | 319 |
320 | 321 |

More Info

322 | 323 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.marks are protected by intellectual property rights.

324 | 325 |
326 |
327 | 328 | 329 |
330 | 331 |
332 | 333 | 334 |
335 | 336 | 337 | 338 | 339 | 340 | -------------------------------------------------------------------------------- /logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /style.css: -------------------------------------------------------------------------------- 1 | html { 2 | scroll-behavior: smooth; 3 | } 4 | 5 | 6 | body { 7 | font-family: 'Open Sans', sans-serif; 8 | letter-spacing: 0.2px; 9 | color: #333; 10 | margin: 0; 11 | } 12 | 13 | h1 { 14 | font-family: 'Noto Serif', serif; 15 | font-size: 39px; 16 | line-height: 42px; 17 | margin-bottom: 50px; 18 | 19 | } 20 | 21 | h2 { 22 | font-family: 'Noto Serif', serif; 23 | font-size: 28px; 24 | line-height: 30px; 25 | text-align: center; 26 | color: #333; 27 | margin-block-start: 40px; 28 | margin-block-end: 30px; 29 | margin-inline-start: 0px; 30 | margin-inline-end: 0px; 31 | } 32 | 33 | p { 34 | font-size: 20px; 35 | line-height: 26px; 36 | } 37 | 38 | a { 39 | text-decoration: none; 40 | } 41 | 42 | a:hover { 43 | text-decoration: underline; 44 | } 45 | 46 | .navbar { 47 | overflow: hidden; 48 | background-color: #0098f1; 49 | color: #333; 50 | top: 0; 51 | width: 100%; 52 | height: 70px; 53 | font-size: 15px; 54 | text-align: right; 55 | padding: 12px 0 0 0; 56 | position: fixed; 57 | z-index: 1; 58 | } 59 | 60 | .navbar a { 61 | margin-right: 40px; 62 | color: #333; 63 | } 64 | 65 | .navbar a:active { 66 | text-decoration: underline; 67 | } 68 | 69 | .right a { 70 | float: right; 71 | } 72 | 73 | .container { 74 | width: 100%; 75 | } 76 | 77 | .top { 78 | background-color: #0098f1; 79 | height: 650px; 80 | } 81 | 82 | .clear { 83 | background-color: #fff; 84 | height: auto; 85 | } 86 | 87 | .nav-top { 88 | border-top: 8px solid #0098f1; 89 | } 90 | 91 | .row { 92 | max-width: 63rem; 93 | margin: auto; 94 | display: block; 95 | } 96 | 97 | .content { 98 | padding: 22px; 99 | } 100 | 101 | .wrapper { 102 | display: flex; 103 | padding: 22px; 104 | } 105 | 106 | .sidepanel { 107 | width: 200px; 108 | margin-top: 120px; 109 | background-color: #fff; 110 | overflow-x: hidden; 111 | position: fixed; 112 | height: 80%; 113 | 114 | } 115 | 116 | .sidepanel a.title { 117 | font-family: 'Noto Serif', serif; 118 | font-size: 18px; 119 | font-weight: 600; 120 | text-align: left; 121 | text-decoration: none; 122 | color: #333; 123 | display: block; 124 | padding-bottom: 12px; 125 | } 126 | 127 | .sidepanel a.section { 128 | font-family: 'Open Sans', sans-serif; 129 | font-size: 15px; 130 | text-align: left; 131 | line-height: 30px; 132 | display: block; 133 | text-decoration: none; 134 | color: #333; 135 | } 136 | 137 | .sidepanel a.sub-section { 138 | font-family: 'Open Sans', sans-serif; 139 | font-size: 15px; 140 | text-align: left; 141 | line-height: 25px; 142 | display: block; 143 | text-decoration: none; 144 | color: #333; 145 | padding-left: 20px; 146 | 147 | } 148 | 149 | .sidepanel a.title:hover, 150 | .sidepanel a.section:hover, 151 | .sidepanel a.sub-section:hover { 152 | text-decoration: underline; 153 | } 154 | 155 | .main-col { 156 | width: 70%; 157 | margin: auto; 158 | text-align: center; 159 | } 160 | 161 | .main-col p { 162 | font-size: 15px; 163 | line-height: 24px; 164 | margin-bottom: 36px; 165 | } 166 | 167 | .right-col { 168 | margin-top: 100px; 169 | text-align: left; 170 | width: 100%; 171 | margin-left: 220px; 172 | } 173 | 174 | .right-col h1 { 175 | font-size: 24px; 176 | line-height: 28px; 177 | margin-bottom: 24px; 178 | } 179 | 180 | .right-col h2 { 181 | font-size: 21px; 182 | line-height: 24px; 183 | margin-bottom: 30px; 184 | text-align: left; 185 | margin-block-start: 20px; 186 | margin-block-end: 10px; 187 | } 188 | 189 | .right-col p { 190 | font-size: 16px; 191 | line-height: 22px; 192 | margin-bottom: 36px; 193 | } 194 | 195 | .right-col a { 196 | color: #0098f1; 197 | text-decoration: underline; 198 | } 199 | 200 | .right-col ol { 201 | margin-block-start: 10px; 202 | } 203 | 204 | .logo { 205 | width: 150px; 206 | float: left; 207 | margin: -10px 30px; 208 | } 209 | 210 | .col { 211 | width: 50%; 212 | float: left; 213 | } 214 | 215 | .top-info { 216 | font-family: 'Open Sans', sans-serif; 217 | font-size: 17px; 218 | text-align: center; 219 | 220 | } 221 | 222 | .divider { 223 | width: 40px; 224 | height: 4px; 225 | background: #0098f1; 226 | border-radius: 30px; 227 | margin: auto; 228 | margin-top: 8px; 229 | margin-bottom: 8px; 230 | } 231 | 232 | .left { 233 | margin: 20px 0; 234 | } 235 | 236 | 237 | .footer { 238 | float: left; 239 | width: 100%; 240 | padding: 90px 0 20px; 241 | font-size: 15px; 242 | text-align: center; 243 | background-color: #fff; 244 | } 245 | 246 | .footer a { 247 | color: #333; 248 | } 249 | 250 | .resp-break { 251 | display: none; 252 | } 253 | 254 | .break { 255 | display: block; 256 | } 257 | 258 | .space { 259 | height: 30px; 260 | width: 100%; 261 | float: left; 262 | } 263 | 264 | .double { 265 | height: 60px; 266 | } 267 | 268 | .links { 269 | float: left; 270 | padding-bottom: 8px; 271 | } 272 | 273 | 274 | 275 | /* Break Points */ 276 | 277 | 278 | /* Extra small-small devices (phones, 420px and down) */ 279 | @media only screen and (max-width: 420px) { 280 | 281 | .logo { 282 | width: 100px; 283 | } 284 | 285 | .navbar { 286 | height: auto; 287 | } 288 | 289 | h2 { 290 | font-size: 24px; 291 | } 292 | 293 | .links { 294 | float: none; 295 | } 296 | 297 | } 298 | 299 | 300 | 301 | /* Extra small devices (phones, 650px and down) */ 302 | @media only screen and (max-width: 650px) { 303 | 304 | .logo { 305 | width: 115px; 306 | margin: -10px 0px; 307 | } 308 | 309 | .navbar a { 310 | padding-bottom: 5px; 311 | margin-left: 40px; 312 | margin-right: 0; 313 | } 314 | 315 | .resp-break { 316 | display: block; 317 | margin: 17px; 318 | } 319 | 320 | .main-col { 321 | width: 100%; 322 | } 323 | 324 | 325 | .wrapper { 326 | display: block; 327 | } 328 | 329 | .sidepanel { 330 | width: 100%; 331 | text-align: center; 332 | position: relative; 333 | height: auto; 334 | } 335 | 336 | .sidepanel a.title, 337 | .sidepanel a.section, 338 | .sidepanel a.sub-section { 339 | text-align: center; 340 | } 341 | 342 | .left { 343 | margin: 20px auto; 344 | } 345 | 346 | .right-col { 347 | position: relative; 348 | margin-top: 20px; 349 | margin-left: 0px; 350 | 351 | } 352 | } 353 | 354 | /* Small devices (portrait tablets and large phones, 650px and up) */ 355 | @media only screen and (min-width: 650px) { 356 | 357 | .logo { 358 | margin: -10px 0px; 359 | } 360 | 361 | .right a { 362 | float: right; 363 | padding-bottom: 5px; 364 | } 365 | 366 | 367 | 368 | } 369 | 370 | /* Medium devices (landscape tablets, 768px and up) */ 371 | @media only screen and (min-width: 768px) .logo { 372 | margin: -10px 0px; 373 | } 374 | } 375 | 376 | /* Large devices (laptops/desktops, 992px and up) */ 377 | @media only screen and (min-width: 992px) {} 378 | 379 | 380 | /* End Break Points */ 381 | --------------------------------------------------------------------------------