/UmbracoDocs

The official Umbraco Documentation

Umbraco Documentation project

Reading & using the docs

This is the documentation project for Umbraco. The scope of this project is to provide overviews of concepts, tutorials, example code, and links to API reference. We welcome valuable contributions from anyone willing to help. No matter if it is correcting spelling mistakes, raising an issue or writing a tutorial, everything counts and helps make Umbraco easier to use for everyone.

For details on how to contribute, see further down this page.

What's in the documentation

Getting started

Getting started (available here) is an introduction to Umbraco containing explanations of basic concepts and short tutorials.

Implementation

Implementation (available here) is an overview of Umbracos structure and pipeline.

Developers Reference

Reference (available here) is a collection of API references specifically for developers working with and extending Umbraco.

Extending

Extending (available here) is documentation on customizing and extending the backoffice.

Tutorials

Tutorials (available here) is a collection of the more extensive tutorials used in the documentation.

Contributing to the documentation

Please read our Contributing Guidelines to learn how you can get involved and help with the Umbraco Documentation.

Markdown conventions

Keep custom HTML to a minimum. All script and style markup are cleaned by default. For reference, the Markdown syntax guide is available.

Images

Images are stored and linked relatively to .md pages, and should by convention always be in an images folder. So to add an image to /documentation/reference/partials/renderviewpage.md you link it like so:

![My Image Alt Text](images/img.jpg)

And store the image as /documentation/reference/partials/images/img.jpg

Images can have a maximum width of 800px. Please always try to use the most efficient compression, gif, png or jpg. No bmp, tiff or swf (Flash), please.

NB: In order to get images to display correctly on GitHub, all image URLs must end with ``.

External links

Include either the complete URL, or link using Markdown:

https://yahoo.com/something

or

[yahoo something](https://yahoo.com/something)

Internal links

If you need to link between pages, always link relatively, and include the .md extension.

[Umbraco.Helpers](Umbraco.Helpers.md)

or

[Umbraco.Helpers](../../Reference/Umbraco.Helpers.md)

Formatting code

Indent your sample with a single tab, which will cause it to be rendered as <pre><code> tags. For inline code, wrap in ` (backtick) chars.

Use # for the headline, ## for sub headers and ### for parameters (on code reference pages)

For optional parameters wrap in _ (underscore) - end result: ###_optionalParameter_

Structure

For the documentation project, each individual topic is contained in its own folder. Each folder must have an index.md file which links to the individual sub-pages, if images are used, these must be in images folders next to the .md file referencing them relatively.

  • topic
    • images
      • images.jpg
    • Subtopic
      • images
      • index.md
    • index.md
    • otherpage.md

Annotating a document

To add version information and extra keywords, every document can be annotated using YAML.

Multi version documentation

With the introduction every new version of Umbraco new features are introduced. This means that not every document will work for your possibly older version.

Therefor we introduced 2 different mechanisms.

  1. the YAML meta data describing versionFrom and versionTo.
  2. the possibility to add multiple files about the same topic