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.webp" 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 its 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 GitHub sponsors &raquo;</a>
 152                                                 <br>
 153                                                 <a href="/donate/">View donate & sponsor options &raquo;</a>
 154                                                 <p><br></p>
 155                                         </p>
 156                                 </div>
 157                                 <div class="col-sm-8 text-center">
 158                                         <!-- <p><br></p> -->
 159                                         <h5>Our Gold Sponsor</h5>
 160
 161                                         <div class="sponsor-list">
 162                                                 <a href="https://www.federated.computer/bookstack/" target="_blank">
 163                                                         <img width="560" src="/images/sponsors/federated-computer.png" alt="Federated.computer logo">
 164                                                 </a>
 165                                         </div>
 166
 167                                         <p><br></p>
 168                                         <!-- <h5>Our Silver Sponsor</h5>
 169
 170                                         <div class="sponsor-list">
 171
 172                                         </div> -->
 173
 174                                         <!-- <p><br></p> -->
 175
 176                                         <h5>Our Bronze Sponsors</h5>
 177
 178                                         <div class="sponsor-list">
 179
 180                                                 <a href="https://www.diagrams.net/" target="_blank">
 181                                                         <img width="280" src="/images/sponsors/diagramsnet.png" alt="Diagrams.net logo">
 182                                                 </a>
 183
 184                                                 <a href="https://www.stellarhosted.com/bookstack/" target="_blank">
 185                                                         <img width="280" src="/images/sponsors/stellarhosted.png" alt="Stellar Hosted logo">
 186                                                 </a>
 187
 188                                                 <a href="https://cloudabove.com/hosting" target="_blank">
 189                                                         <img height="86" src="/images/sponsors/cloudabove.png" alt="Cloudabove logo">
 190                                                 </a>
 191
 192                                                 <a href="https://www.practicali.be" target="_blank">
 193                                                         <img height="86" src="/images/sponsors/practicali.png" alt="Practicali logo">
 194                                                 </a>
 195
 196                                                 <a href="https://nws.netways.de/apps/bookstack/" target="_blank">
 197                                                         <img width="280" src="/images/sponsors/netways.png" alt="NETWAYS Web Services logo">
 198                                                 </a>
 199
 200                                                 <a href="https://www.schroeck-consulting.de/" target="_blank">
 201                                                         <img width="230" src="/images/sponsors/schroeck-consulting.png" alt="Schroeck IT Consulting logo">
 202                                                 </a>
 203
 204                                                 <a href="https://practinet.be/" target="_blank">
 205                                                         <img height="86" src="/images/sponsors/practinet.png" alt="Practinet logo">
 206                                                 </a>
 207
 208                                                 <a href="https://route4me.com/" target="_blank">
 209                                                         <img height="86" src="/images/sponsors/route4me.png" alt="Route4Me logo - Route Optimizer and Route Planner Software">
 210                                                 </a>
 211
 212                                         </div>
 213
 214                                 </div>
 215                         </div>
 216
 217                 </div>
 218         </div>
 219
 220
 221
 222     <div class="shaded shaded-border md-margin-top padded-vertical large">
 223         <div class="container">
 224                 <div class="row">
 225                         <div class="col-sm-6">
 226                                 <h2 class="nomargin margin-bottom" id="demo">Try Out BookStack</h2>
 227                                 <p>
 228                                         You can try out BookStack right now by using the given details.
 229                                         <strong>The demo database &amp; image storage is automatically reset every half hour.</strong>
 230                                         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.
 231                                 </p>
 232                                         <div>
 233                                                 <strong>Actions Restricted In Demo</strong>
 234                                                 <ul>
 235                                                         <li>User deletion</li>
 236                                                         <li>User updates</li>
 237                                                         <li>Setting updates</li>
 238                                                 </ul>
 239                                         </div>
 240                         </div>
 241                         <div class="col-sm-6 text-center">
 242                                         <div class="demo-box text-left " >
 243                                                 <label>Demo site url</label> <br><a href="https://demo.bookstackapp.com" target="_blank">https://demo.bookstackapp.com</a> <br>
 244                                                 <label for="demo-email">Admin email</label> <br><input id="demo-email" type="text" onclick="this.select();" value="admin@example.com" readonly="true"><br>
 245                                                 <label for="demo-password">Admin password</label> <br><input id="demo-password" type="text" onclick="this.select();" value="password" readonly="true"> <br><br>
 246                                                 <a href="https://demo.bookstackapp.com/login?email=admin@example.com&password=password" class="button" target="_blank">Open demo site</a>
 247                                         </div>
 248                         </div>
 249                 </div>
 250         </div>
 251     </div>
 252
 253         <div class="padded-vertical large">
 254                 <div class="container">
 255                         <h2 class="nomargin margin-bottom" id="screenshots">Screenshots</h2>
 256                         <div class="my-gallery">
 257                                 <div class="row">
 258                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 259                                                 <h4>Page View</h4>
 260                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 261                                                         <figcaption>How core content is viewed in BookStack</figcaption>
 262                                                     <a href="images/screenshots/page-view.png" data-size="1666x910">
 263                                                         <img src="images/screenshots/thumb_page-view.png" alt="Page View" loading="lazy">
 264                                                     </a>
 265                                                 </figure>
 266                                         </div>
 267                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 268                                                 <h4>Page Editor</h4>
 269                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 270                                                         <figcaption>The WYSIWYG interface for editing pages</figcaption>
 271                                                     <a href="images/screenshots/page-edit.png" data-size="1666x910">
 272                                                         <img src="images/screenshots/thumb_page-edit.png" alt="Page Editing" loading="lazy">
 273                                                     </a>
 274                                                 </figure>
 275                                         </div>
 276                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 277                                                 <h4>Image Manager</h4>
 278                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 279                                                         <figcaption>How images are uploaded and managed</figcaption>
 280                                                     <a href="images/screenshots/image-manager.png" data-size="1666x910">
 281                                                         <img src="images/screenshots/thumb_image-manager.png" alt="Image Manager" loading="lazy">
 282                                                     </a>
 283                                                 </figure>
 284                                         </div>
 285                                 </div>
 286
 287                                 <br>
 288
 289                                 <div class="row">
 290                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 291                                                 <h4>All Books Overview</h4>
 292                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 293                                                         <figcaption>An overview of the top-level categorisation</figcaption>
 294                                                     <a href="images/screenshots/books-view.png" data-size="1666x910">
 295                                                         <img src="images/screenshots/thumb_books-view.png" alt="View of all books" loading="lazy">
 296                                                     </a>
 297                                                 </figure>
 298                                         </div>
 299                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 300                                                 <h4>Book Overview</h4>
 301                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 302                                                         <figcaption>A view of the main content container: A book</figcaption>
 303                                                     <a href="images/screenshots/book-overview.png" data-size="1666x910">
 304                                                         <img src="images/screenshots/thumb_book-overview.png" alt="Book Overview" loading="lazy">
 305                                                     </a>
 306                                                 </figure>
 307                                         </div>
 308                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 309                                                 <h4>Book Sorting</h4>
 310                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 311                                                         <figcaption>How created content can be sorted within a book</figcaption>
 312                                                     <a href="images/screenshots/book-sorting.png" data-size="1666x910">
 313                                                         <img src="images/screenshots/thumb_book-sorting.png" alt="Book Content Sorting View" loading="lazy">
 314                                                     </a>
 315                                                 </figure>
 316                                         </div>
 317                                 </div>
 318
 319                                 <br>
 320
 321                                 <div class="row">
 322                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 323                                                 <h4>Global Search</h4>
 324                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 325                                                         <figcaption>The main interface for searching created content</figcaption>
 326                                                     <a href="images/screenshots/search.png" data-size="1666x910">
 327                                                         <img src="images/screenshots/thumb_search.png" alt="Searching all content" loading="lazy">
 328                                                     </a>
 329                                                 </figure>
 330                                         </div>
 331                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 332                                                 <h4>App Settings</h4>
 333                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 334                                                         <figcaption>A view the of application system settings</figcaption>
 335                                                     <a href="images/screenshots/settings-view.png" data-size="1666x910">
 336                                                         <img src="images/screenshots/thumb_settings-view.png" alt="Settings View" loading="lazy">
 337                                                     </a>
 338                                                 </figure>
 339                                         </div>
 340                                         <div class="col-sm-4 col-sm-offset-0 col-xs-8 col-xs-offset-2">
 341                                                 <h4>Profile Page</h4>
 342                                                 <figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
 343                                                         <figcaption>A user profile page, showing their activity and content</figcaption>
 344                                                     <a href="images/screenshots/profile-page.png" data-size="1666x910">
 345                                                         <img src="images/screenshots/thumb_profile-page.png" alt="Profile Editing Screen" loading="lazy">
 346                                                     </a>
 347                                                 </figure>
 348                                         </div>
 349                                 </div>
 350
 351                         </div>
 352                 </div>
 353         </div>
 354
 355
 356     <div class="shaded shaded-border md-margin-top padded-vertical large" id="blog-list">
 357         <div class="container">
 358             <h2>Latest From The Blog</h2>
 359
 360                         <div class="blogpost-cards">
 361                                 {{ range first 4 ( where .Site.Pages "Section" "blog") }}
 362                                         <div class="blogpost-card">
 363                                                 <a href="{{.Permalink}}">
 364                                                         {{ if .Params.image }}
 365                                                             {{ $image := resources.Get .Params.image }}
 366                                                                 {{ $sized := $image.Resize "604x q90" }}
 367                                                                 <div class="image">
 368                                                                         <img src="{{$sized.RelPermalink}}" loading="lazy" width="302" height="160" alt="{{ .Title }}">
 369                                                                 </div>
 370                                                         {{ end }}
 371                                                         <div class="text">{{ .Title }}</div>
 372                                                 </a>
 373                                         </div>
 374                                 {{ end }}
 375                         </div>
 376
 377                         <div class="clearfix"></div>
 378
 379             <div class="padded-top"><a class="button" href="/blog">Read the blog &raquo;</a></div>
 380         </div>
 381     </div>
 382
 383     <!-- Root element of PhotoSwipe. Must have class pswp. -->
 384         <div class="pswp" tabindex="-1" role="dialog" aria-hidden="true">
 385             <div class="pswp__bg"></div>
 386             <div class="pswp__scroll-wrap">
 387                 <div class="pswp__container">
 388                     <div class="pswp__item"></div>
 389                     <div class="pswp__item"></div>
 390                     <div class="pswp__item"></div>
 391                 </div>
 392                 <div class="pswp__ui pswp__ui--hidden">
 393                     <div class="pswp__top-bar">
 394                         <div class="pswp__counter"></div>
 395                         <button class="pswp__button pswp__button--close" title="Close (Esc)"></button>
 396                         <button class="pswp__button pswp__button--share" title="Share"></button>
 397                         <button class="pswp__button pswp__button--fs" title="Toggle fullscreen"></button>
 398                         <button class="pswp__button pswp__button--zoom" title="Zoom in/out"></button>
 399                         <div class="pswp__preloader">
 400                             <div class="pswp__preloader__icn">
 401                               <div class="pswp__preloader__cut">
 402                                 <div class="pswp__preloader__donut"></div>
 403                               </div>
 404                             </div>
 405                         </div>
 406                     </div>
 407                     <div class="pswp__share-modal pswp__share-modal--hidden pswp__single-tap">
 408                         <div class="pswp__share-tooltip"></div>
 409                     </div>
 410                     <button class="pswp__button pswp__button--arrow--left" title="Previous (arrow left)">
 411                     </button>
 412                     <button class="pswp__button pswp__button--arrow--right" title="Next (arrow right)">
 413                     </button>
 414                     <div class="pswp__caption">
 415                         <div class="pswp__caption__center"></div>
 416                     </div>
 417                 </div>
 418             </div>
 419         </div>
 420
 421         <script async src="libs/photoswipe.min.js"></script>
 422
 423 {{ partial "footer.html" . }}