24 votes

Bookshelf

Umbraco Bookshelf allows users to create, display and share Umbraco learning resources quickly by providing some basic markdown functionality via a custom section.

Bookshelf works by reading markdown files from the UmbracoBookshelf folder of your website.

Install a Book

Books are available via the Bookshelf dashboard or http://our.umbraco.org in the packages section. Install like you would any other Umbraco Package. 

For instance Archetype has a manual than can be put on your bookshelf: https://github.com/kgiszewski/ArchetypeManual

Editing a Book

To edit a book, simply click Edit on an .md file page. If the book is hosted on GitHub, please consider sending revisions and additional content.

Creating a Book

Books are just .md files that live in the UmbracoBookshelf folder of your webroot. So to create a book, just create a sub-folder next to your other books (like this one). By default when a user clicks the folder in the tree to the left, the README.md file is loaded for the user.

Books should be written in Markdown and Bookshelf recognizes Github Flavored Markdown. Please use the following resources when learning Markdown:

https://help.github.com/articles/markdown-basics/

https://help.github.com/articles/github-flavored-markdown/

Please refrain from using HTML directly when possible. Some things like embedding videos are unavoidable.

Consider Contributing Your Time

If you like Bookshelf, please consider helping by adding features or creating books for others to use.

Install Notes

Be sure to visit the Users section after install to add the section to any users you would like.

You can also install via NuGet (recommended): https://www.nuget.org/packages/UmbracoBookshelf/

Bookshelf Directory

By default the books will be stored on your webroot at "~/UmbracoBookshelf".  You can change that to another directory by changing the following app setting:

    <add key="UmbracoBookshelf:customFolder" value="~/somewhere else" />

Combine with virtual directories and you can keep books in a separate directory under separate source control.

Source

https://github.com/kgiszewski/UmbracoBookshelf

Versions

For 7.2.8 and below use v0.10.4

For 7.3+ use v0.10.5+

For 7.6.3 use v.0.11.0+

Screenshots

Project owner

Kevin Giszewski

Kevin Giszewski

Kevin has 3414 karma points

Project Compatibility

This project is compatible with the following versions as reported by community members who have downloaded this package:
Works on Umbraco Cloud
7.7.x (untested)
7.6.x (33%)
7.5.x (50%)
7.4.x (untested)
7.3.x (0%)
7.2.x (75%)
7.1.x (untested)
7.0.x (untested)
6.1.x (0%)
6.0.x (0%)

You must login before you can report on package compatibility.

Project Information

  • Project owner: Kevin Giszewski
  • Created: 05/03/2015
  • Current version 0.11.0
  • .net Version 4.0,4.5
  • License MIT
  • Downloads: 1236