Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

umbraco/UmbracoDocs.Preview

Repository files navigation

UmbracoDocs Preview App

The UmbracoDocs project repository contains only markdown which will not render correctly unless served by the Our.Umbraco project...

Until now!.

Introducing UmbracoDocs Preview App! This tool renders UmbracoDocs without all of the overhead of setting up our.umbraco.

Be warned this project is somewhat experimental and definitely has some limitations, it's unlikely to ever gain any sort of official support as the documentation platform is scheduled for a refresh.

Until 1.0.0 everything is subject to change and it's highly likely there will never be a 1.0.0 release.

Installing from nuget.org

This project can be found on nuget at https://www.nuget.org/packages/Umbraco.Docs.Preview.App/

You can run the following to install as a global tool.

$ dotnet tool install --global Umbraco.Docs.Preview.App

Running the project

$ umbracodocs # from UmbracoDocs repository
$ umbracodocs -h # view help.

And you're ready to view the docs by default at http://localhost:5000.

When you update a markdown document your browser will automatically reload.

This could be useful for testing contributions to UmbracoDocs or just to facilitate reading the docs without an internet connection.

Install local build

$ dotnet pack -o dist
$ dotnet tool install -g --add-source ./dist Umbraco.Docs.Preview.App

Uninstall

$ dotnet tool uninstall -g umbraco.docs.preview.app