BookStack Code Mirror - website/blob - themes/bookstack/layouts/index.html

 1 {{ partial "header.html" . }}
 2 <div class="header">
 3         <div class="container">
 4                 <div class="row hero">
 5                     <div class="col-md-4 spaced">
 6                         <h1>Simple &amp; Free <br>Wiki Software</h1>
 7                         <p>BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information.</p>
 8                         <p>
 9                           <a href="https://github.com/BookStackApp/BookStack">GitHub</a> &nbsp;-&nbsp;
 10                           <a href="https://demo.bookstackapp.com">Demo</a> &nbsp;-&nbsp;
 11                           <a href="/docs/admin/installation">Install</a>
 12                         </p>
 13
 14                                 <p class="nomargin">
 15                                         <br>
 16                                         Latest Blog Post: <br>
 17                                         {{ range first 1 ( where .Site.Pages "Section" "blog") }}
 18                                                         <a href="{{.Permalink}}">{{ .Title }}</a>
 19                                         {{ end }}
 20                                 </p>
 21                     </div>
 22                     <div class="col-md-8 screenshot-container-parent">
 23                         <div class="screenshot-container">
 24                                 <div class="window-row">
 25                                         <div class="window-option red"></div>
 26                                         <div class="window-option" style="background-color: orange;"></div>
 27                                         <div class="window-option"  style="background-color: green;"></div>
 28                                 </div>
 29                                 <img class="screenshot" src="images/bookstack-hero-screenshot.jpg" alt="BookStack ScreenShot">
 30                         </div>
 31                     </div>
 32                 </div>
 33         </div>
 34 </div>
 35
 36
 37   <div class="container md-margin-top">
 38         <h2 id="features" class="nomargin margin-bottom">Features</h2>
 39         <div class="row">
 40             <div class="col-sm-4">
 41                 <h4><span class="icon" aria-hidden="true">{{partial "icon/code.svg"}}</span>Free &amp; Open Source</h4>
 42                 <p>BookStack is fully free and open, MIT licensed. The source is available on GitHub. There is no cost to downloading and installing your own instance of bookstack.
 43                 </p>
 44                 <p>
 45                     <a href="https://github.com/BookStackApp/BookStack">View the source here &raquo;</a>
 46                 </p>
 47             </div>
 48             <div class="col-sm-4" >
 49                 <h4><span class="icon" aria-hidden="true">{{partial "icon/laptop_chromebook.svg"}}</span>Easy, Simple Interface</h4>
 50                 <p>
 51                     Simplicity has been the top priority when building BookStack. The page editor has a simple WYSIWYG interface and all content is broken into three simple real world groups:
 52                 </p>
 53                 <p>
 54                                         <span class="icon book" aria-hidden="true">{{partial "icon/book.svg"}}</span>Books
 55                                         &nbsp;&nbsp;<span class="icon chapter" aria-hidden="true">{{partial "icon/collections_bookmark.svg"}}</span>Chapters&nbsp;&nbsp;
 56                                         <span class="icon page" aria-hidden="true">{{partial "icon/description.svg"}}</span>Pages
 57                 </p>
 58             </div>
 59             <div class="col-sm-4" >
 60                 <h4><span class="icon" aria-hidden="true">{{partial "icon/search.svg"}}</span>Searchable and Connected</h4>
 61                 <p>
 62                     The content in BookStack is fully searchable. You are able to search at book level or across all books, chapters &amp; pages. The ability to link directly to any paragraph allows you to keep your documentation connected.
 63                 </p>
 64             </div>
 65         </div>
 66         <p>
 67             <br>
 68         </p>
 69         <div class="row">
 70             <div class="col-sm-4">
 71                 <h4><span class="icon" aria-hidden="true">{{partial "icon/build.svg"}}</span>Configurable</h4>
 72                 <p>
 73                     Configuration options allow you to set-up BookStack to suit your use case. You can change the name, logo and registration options. You can also change whether the whole system is publicly viewable or not.
 74                 </p>
 75             </div>
 76             <div class="col-sm-4" >
 77                 <h4><span class="icon" aria-hidden="true">{{partial "icon/storage.svg"}}</span>Simple Requirements</h4>
 78                 <p>
 79                     BookStack is built using PHP, on top of the Laravel framework and it uses MySQL to store data. Performance has been kept in mind and BookStack can run happily on a $5 Digital Ocean VPS.
 80                 </p>
 81             </div>
 82             <div class="col-sm-4">
 83                 <h4><span class="icon" aria-hidden="true">{{partial "icon/drawing.svg"}}</span>Built-In diagrams.net</h4>
 84                 <p>
 85                     The page editor within BookStack has <a href="https://www.diagrams.net/" target="_blank">diagrams.net</a>
 86                     drawing capability built-in, allowing the quick and easy creation of diagrams within your documentation.
 87                 </p>
 88             </div>
 89         </div>
 90         <p>
 91             <br>
 92         </p>
 93         <div class="row">
 94             <div class="col-sm-4">
 95                 <h4><span class="icon" aria-hidden="true">{{partial "icon/language.svg"}}</span>Multi-Lingual</h4>
 96                 <p>
 97                     BookStack users can set their preferred language. Thanks to great community contributors, current languages built into BookStack include EN, FR, DE, ES, IT, JA, NL, PL, RU and <a href="https://crowdin.com/project/bookstack" target="_blank">many more</a>.
 98                 </p>
 99             </div>
 100             <div class="col-sm-4" >
 101                 <h4><span class="icon" aria-hidden="true">{{partial "icon/edit.svg"}}</span>Optional Markdown Editor</h4>
 102                 <p>
 103                    If you prefer to write in Markdown then BookStack supports you. A markdown editor is provided and includes a live-preview as you write your documentation.
 104                 </p>
 105             </div>
 106             <div class="col-sm-4" >
 107                 <h4><span class="icon" aria-hidden="true">{{partial "icon/lock.svg"}}</span>Integrated Authentication</h4>
 108                 <p>
 109                         As well as the default email/password login social providers such as GitHub, Google, Slack, AzureAD and more can be used. Okta, SAML2 and LDAP options are available for enterprise environments.
 110                 </p>
 111             </div>
 112         </div>
 113         <p>
 114             <br>
 115         </p>
 116         <div class="row">
 117                 <div class="col-sm-4" >
 118                     <h4><span class="icon" aria-hidden="true">{{partial "icon/directions_boat.svg"}}</span>Powerful Features</h4>
 119                     <p>
 120                         On top of the powerful search and linking there is also cross-book sorting, page revisions and image management. A full role and permission system allow you to lock down content and actions as required.
 121                     </p>
 122                 </div>
 123             <div class="col-sm-4" >
 124                 <h4><span class="icon" aria-hidden="true">{{partial "icon/mfa.svg"}}</span>Multi-Factor Authentication</h4>
 125                 <p>
 126                         MFA is built in & can be enforced at a per-role level where desired.
 127                         MFA options include TOTP (Google/Microsoft Authenticator, Authy, etc...) and static backup codes.
 128                 </p>
 129             </div>
 130             <div class="col-sm-4" >
 131                 <h4><span class="icon" aria-hidden="true">{{partial "icon/dark-mode.svg"}}</span>Dark & Light Modes</h4>
 132                 <p>
 133                    BookStack provides it's user interface in both a light theme and a dark theme, saving the eyes
 134                    of those that prefer to work in the shadows. This is configurable at a user level.
 135                 </p>
 136             </div>
 137         </div>
 138     </div>
 139
 140
 141         <div class="shaded-border md-margin-top">
 142                 <div class="container md-margin-top">
 143                         <div class="row">
 144                                 <div class="col-sm-4">
 145                                         <h2 id="sponsors" class="nomargin margin-bottom">Project Sponsors</h2>
 146                                         <p>
 147                                                 Shown are our bronze, silver and gold project sponsors. <br>
 148                                                 Big thanks to these companies for supporting the project. <br>
 149                                                 Note: Listed services are not tested, vetted nor supported by the official BookStack project in any manner. <br>
 150                                                 <br>
 151                                                 <a target="_blank" href="https://github.com/sponsors/ssddanbrown">View all sponsors &raquo;</a>
 152                                         </p>
 153                                 </div>
 154                                 <div class="col-sm-8 text-center">
 155                                         <p><br></p>
 156                                         <h5>Our Bronze Sponsors</h5>
 157
 158                                         <div class="sponsor-list">
 159
 160                                                 <a href="https://www.diagrams.net/" target="_blank">
 161                                                         <img width="280" src="/images/sponsors/diagramsnet.png" alt="Diagrams.net logo">
 162                                                 </a>
 163
 164                                                 <a href="https://www.stellarhosted.com/bookstack/" target="_blank">
 165                                                         <img width="280" src="/images/sponsors/stellarhosted.png" alt="Stellar Hosted Logo">
 166                                                 </a>
 167
 168                                         </div>
 169
 170                                 </div>
 171                         </div>
 172
 173                 </div>
 174         </div>
 175
 176
 177
 178     <div class="shaded shaded-border md-margin-top padded-vertical large">
 179         <div class="container">
 180                 <div class="row">
 181                         <div class="col-sm-6">
 182                                 <h2 class="nomargin margin-bottom" id="demo">Try Out BookStack</h2>
 183                                 <p>
 184                                         You can try out BookStack right now by using the given details.
 185                                         <strong>The demo database &amp; image storage is automatically reset every half hour.</strong>
 186                                         Most standard actions are available using the provided admin login but some actions, listed below, have been restricted to keep the demo instance open &amp; available. That said, all options &amp; actions are at least visible to the demo admin user.
 187                                 </p>
 188                                         <div>
 189                                                 <strong>Actions Restricted In Demo</strong>
 190                                                 <ul>
 191                                                         <li>User deletion</li>
 192                                                         <li>User updates</li>
 193                                                         <li>Setting updates</li>
 194                                                 </ul>
 195                                         </div>
 196                         </div>
 197                         <div class="col-sm-6 text-center">
 198                                         <div class="demo-box text-left " >
 199                                                 <label>Demo site url</label> <br><a href="https://demo.bookstackapp.com" target="_blank">https://demo.bookstackapp.com</a> <br>
 200                                                 <label for="demo-email">Admin email</label> <br><input id="demo-email" type="text" onclick="this.select();" value="admin@example.com" readonly="true"><br>
 201                                                 <label for="demo-password">Admin password</label> <br><input id="demo-password" type="text" onclick="this.select();" value="password" readonly="true"> <br><br>
 202                                                 <a href="https://demo.bookstackapp.com/login?email=admin@example.com&password=password" class="button" target="_blank">Open demo site</a>
 203                                         </div>
 204                         </div>
 205                 </div>
 206         </div>
 207     </div>
 208
 209         <div class="padded-vertical large">
 210                 <div class="container">
 211                         <h2 class="nomargin margin-bottom" id="screenshots">Screenshots</h2>
 212                         <div class="my-gallery">
 213                                 <div class="row">
 214                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 215                                                 <h4>Page View</h4>
 216                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 217                                                         <figcaption>How core content is viewed in BookStack</figcaption>
 218                                                     <a href="images/screenshots/page-view.png" data-size="1666x910">
 219                                                         <img src="images/screenshots/thumb_page-view.png" alt="Page View" loading="lazy">
 220                                                     </a>
 221                                                 </figure>
 222                                         </div>
 223                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 224                                                 <h4>Page Editor</h4>
 225                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 226                                                         <figcaption>The WYSIWYG interface for editing pages</figcaption>
 227                                                     <a href="images/screenshots/page-edit.png" data-size="1666x910">
 228                                                         <img src="images/screenshots/thumb_page-edit.png" alt="Page Editing" loading="lazy">
 229                                                     </a>
 230                                                 </figure>
 231                                         </div>
 232                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 233                                                 <h4>Image Manager</h4>
 234                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 235                                                         <figcaption>How images are uploaded and managed</figcaption>
 236                                                     <a href="images/screenshots/image-manager.png" data-size="1666x910">
 237                                                         <img src="images/screenshots/thumb_image-manager.png" alt="Image Manager" loading="lazy">
 238                                                     </a>
 239                                                 </figure>
 240                                         </div>
 241                                 </div>
 242
 243                                 <br>
 244
 245                                 <div class="row">
 246                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 247                                                 <h4>All Books Overview</h4>
 248                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 249                                                         <figcaption>An overview of the top-level categorisation</figcaption>
 250                                                     <a href="images/screenshots/books-view.png" data-size="1666x910">
 251                                                         <img src="images/screenshots/thumb_books-view.png" alt="View of all books" loading="lazy">
 252                                                     </a>
 253                                                 </figure>
 254                                         </div>
 255                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 256                                                 <h4>Book Overview</h4>
 257                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 258                                                         <figcaption>A view of the main content container: A book</figcaption>
 259                                                     <a href="images/screenshots/book-overview.png" data-size="1666x910">
 260                                                         <img src="images/screenshots/thumb_book-overview.png" alt="Book Overview" loading="lazy">
 261                                                     </a>
 262                                                 </figure>
 263                                         </div>
 264                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 265                                                 <h4>Book Sorting</h4>
 266                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 267                                                         <figcaption>How created content can be sorted within a book</figcaption>
 268                                                     <a href="images/screenshots/book-sorting.png" data-size="1666x910">
 269                                                         <img src="images/screenshots/thumb_book-sorting.png" alt="Book Content Sorting View" loading="lazy">
 270                                                     </a>
 271                                                 </figure>
 272                                         </div>
 273                                 </div>
 274
 275                                 <br>
 276
 277                                 <div class="row">
 278                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 279                                                 <h4>Global Search</h4>
 280                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 281                                                         <figcaption>The main interface for searching created content</figcaption>
 282                                                     <a href="images/screenshots/search.png" data-size="1666x910">
 283                                                         <img src="images/screenshots/thumb_search.png" alt="Searching all content" loading="lazy">
 284                                                     </a>
 285                                                 </figure>
 286                                         </div>
 287                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 288                                                 <h4>App Settings</h4>
 289                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 290                                                         <figcaption>A view the of application system settings</figcaption>
 291                                                     <a href="images/screenshots/settings-view.png" data-size="1666x910">
 292                                                         <img src="images/screenshots/thumb_settings-view.png" alt="Settings View" loading="lazy">
 293                                                     </a>
 294                                                 </figure>
 295                                         </div>
 296                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 297                                                 <h4>Profile Page</h4>
 298                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 299                                                         <figcaption>A user profile page, showing their activity and content</figcaption>
 300                                                     <a href="images/screenshots/profile-page.png" data-size="1666x910">
 301                                                         <img src="images/screenshots/thumb_profile-page.png" alt="Profile Editing Screen" loading="lazy">
 302                                                     </a>
 303                                                 </figure>
 304                                         </div>
 305                                 </div>
 306
 307                         </div>
 308                 </div>
 309         </div>
 310
 311
 312     <div class="shaded shaded-border md-margin-top padded-vertical large">
 313         <div class="container">
 314             <h2>Latest From The Blog</h2>
 315
 316                         <div class="blogpost-cards">
 317                                 {{ range first 4 ( where .Site.Pages "Section" "blog") }}
 318                                         <div class="blogpost-card">
 319                                                 <a href="{{.Permalink}}">
 320                                                         {{ if .Params.image }}
 321                                                                 <div class="image" style="background-image: url({{.Params.image}});"></div>
 322                                                         {{ end }}
 323                                                         <div class="text">{{ .Title }}</div>
 324                                                 </a>
 325                                         </div>
 326                                 {{ end }}
 327                         </div>
 328
 329                         <div class="clearfix"></div>
 330
 331             <div class="padded-top"><a class="button" href="/blog">Read the blog &raquo;</a></div>
 332         </div>
 333     </div>
 334
 335     <!-- Root element of PhotoSwipe. Must have class pswp. -->
 336         <div class="pswp" tabindex="-1" role="dialog" aria-hidden="true">
 337             <div class="pswp__bg"></div>
 338             <div class="pswp__scroll-wrap">
 339                 <div class="pswp__container">
 340                     <div class="pswp__item"></div>
 341                     <div class="pswp__item"></div>
 342                     <div class="pswp__item"></div>
 343                 </div>
 344                 <div class="pswp__ui pswp__ui--hidden">
 345                     <div class="pswp__top-bar">
 346                         <div class="pswp__counter"></div>
 347                         <button class="pswp__button pswp__button--close" title="Close (Esc)"></button>
 348                         <button class="pswp__button pswp__button--share" title="Share"></button>
 349                         <button class="pswp__button pswp__button--fs" title="Toggle fullscreen"></button>
 350                         <button class="pswp__button pswp__button--zoom" title="Zoom in/out"></button>
 351                         <div class="pswp__preloader">
 352                             <div class="pswp__preloader__icn">
 353                               <div class="pswp__preloader__cut">
 354                                 <div class="pswp__preloader__donut"></div>
 355                               </div>
 356                             </div>
 357                         </div>
 358                     </div>
 359                     <div class="pswp__share-modal pswp__share-modal--hidden pswp__single-tap">
 360                         <div class="pswp__share-tooltip"></div>
 361                     </div>
 362                     <button class="pswp__button pswp__button--arrow--left" title="Previous (arrow left)">
 363                     </button>
 364                     <button class="pswp__button pswp__button--arrow--right" title="Next (arrow right)">
 365                     </button>
 366                     <div class="pswp__caption">
 367                         <div class="pswp__caption__center"></div>
 368                     </div>
 369                 </div>
 370             </div>
 371         </div>
 372
 373         <script async src="libs/photoswipe.min.js"></script>
 374
 375 {{ partial "footer.html" . }}