BookStack User Guide

Everything a general user needs to know about using BookStack on a regular basis.

Books, Chapters & Pages

The basic BookStack model of data is based around the ideas of storing information in standard books. This was decided upon as it's a simple model that everyone understands and its been tried and tested for many years. There are books, chapters & pages. A book is a 'top level' container of chapters & pages that does not have any information itself other than a short description. Next there are chapters which act as sub-groups of a book and also only have a name and description. Chapters are not neccassary but but they can be usefull to organise and group your content. In books and chapters you have pages which hold all your content.

Books, chapters and pages are colour coordinated throughout BookStack, along with thier own icons, to make is easily visible which one an entity on the page is. Here are the icons for each in thier matching colors:

Screenshot-2015-11-22-at-01.50.02.png

Overall, The structure of BookStack is very basic but the way you use it is completely up to your use case and the information you are storing in it. It's a good idea to define what's becomes a book, chapter or page before extensively filling up your BookStack instance and ensure everyone using the system is aware of your approach. 

Examples Of Different Content

photo-1444792131309-2e517032ded6.jpgImage fish darkness Man were unto years every firmament doesn't in night without moveth all have. Made two face and gathering divided night heaven. Whales two to you'll morning divide had bring give moved tree our that you'll divide fruitful fly won't second blessed upon dominion signs good likeness i

Code Example

This is a success callout, There are a few different types of callouts that you can use to get a reader's attention.

    public function up()
    {
        Schema::create('books', function (Blueprint $table) {
            $table->increments('id');
            $table->string('name');
            $table->string('slug')->indexed();
            $table->text('description');
            $table->timestamps();
        });
    }
Cats Dogs Ferrets Hamsters Parrots Turtles Other Dogs
88 70 60 20 1 44 68

 

  • Oranges
  • Apples
  • Bannanas
  • Grapes

 

photo-1446080501695-8e929f879f2b.jpg

Fruitful set green air isn't. Together Life beginning signs under Also var a = 'i like toast' replenish beginning signs. Upon a hath meat, open made night him in. Of don't. To living may you'll let moveth day all signs it creature brought for let meat lesser dominion can't lesser over gathering stars wherein brought life.

Called his god. Our, is saying one. Male their second likeness all morning.

 

Logging in to the demo site

This demo site has the following credentials:

Email: admin@example.com
Password: password

You can access the login page with the above credentials pre-filled by clicking here.

The demo database & image storage is automatically reset every half hour. Most standard actions are available using the provided admin login but some actions, listed below, have been restricted to keep the demo instance open & available. That said, all options & actions are at least visible to the demo admin user.

Actions Restricted In Demo
  • User deletion
  • User updates
  • Setting updates