Skip to content

Commit

Permalink
Merge pull request #29 from rickbutterfield/feature/1.7.0
Browse files Browse the repository at this point in the history
v1.7.0
  • Loading branch information
rickbutterfield committed Sep 15, 2023
2 parents e3de203 + d4a3da6 commit aee651d
Show file tree
Hide file tree
Showing 36 changed files with 106 additions and 756 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,27 @@

<img src="https://raw.githubusercontent.com/rickbutterfield/Umbraco.Community.BlockPreview/main/.github/readme-assets/icon.png" alt="Umbraco.Community.BlockPreview icon" height="150" align="right">

## Installation
## Getting started
### Installation
The Umbraco 10.4+ version of this package is [available via NuGet](https://www.nuget.org/packages/Umbraco.Community.BlockPreview).

To install the package, you can use either .NET CLI:

```
dotnet add package Umbraco.Community.BlockPreview --version 1.6.1
dotnet add package Umbraco.Community.BlockPreview --version 1.7.0
```

or the older NuGet Package Manager:

```
Install-Package Umbraco.Community.BlockPreview -Version 1.6.1
Install-Package Umbraco.Community.BlockPreview -Version 1.7.0
```

## Setup
### Setup
#### v1.7.0+
If you are using a version prior to 1.7.0, you will likely have a reference to `AddBlockPreview()` in your `Startup.cs`. This can now be removed!

#### Versions earlier than 1.7.0
Once installed, you'll need to add `AddBlockPreview()` to your `Startup.cs` file, before `AddWebsite()`.
```diff
+ @using Umbraco.Community.BlockPreview;
Expand All @@ -38,6 +43,10 @@ Once installed, you'll need to add `AddBlockPreview()` to your `Startup.cs` file
}
```

### Upgrading
If you're upgrading from any version before `1.7.0`, you will need to remove the `App_Plugins/Umbraco.Community.BlockPreview` folder.


## Usage
This package installs a custom Angular preview for both the Block List and Block Grid editors in the backoffice.

Expand Down Expand Up @@ -89,6 +98,14 @@ If your block partials are not in the usual `/Views/Partials/block[grid|list]/Co
## Contribution guidelines
To raise a new bug, create an issue on the GitHub repository. To fix a bug or add new features, fork the repository and send a pull request with your changes. Feel free to add ideas to the repository's issues list if you would to discuss anything related to the library.

### Using the test sites
The repo comes with test sites for both Umbraco 11 and Umbraco 12. Both sites are configured with uSync out of the box to get you up and running with a test site quickly. Use the following credentials to log into the back office:

```
Username: admin@example.com
Password: 1234567890
```

### Who do I talk to?
This project is maintained by [Rick Butterfield](https://rickbutterfield.dev) and contributors. If you have any questions about the project please get in touch on [Twitter](https://twitter.com/rickbutterfield), or by raising an issue on GitHub.

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.6.1
1.7.0
30 changes: 0 additions & 30 deletions build/Our.Umbraco.BlockPreview.targets

This file was deleted.

21 changes: 0 additions & 21 deletions build/Umbraco.Community.BlockPreview.targets

This file was deleted.

Binary file not shown.
58 changes: 0 additions & 58 deletions src/Our.Umbraco.BlockPreview/Our.Umbraco.BlockPreview.csproj

This file was deleted.

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion src/Umbraco.Cms.11.x/Startup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ public void ConfigureServices(IServiceCollection services)
services.AddUmbraco(_env, _config)
.AddBackOffice()
.AddWebsite()
.AddBlockPreview()
.AddComposers()
.Build();
}
Expand Down
30 changes: 0 additions & 30 deletions src/Umbraco.Cms.11.x/Umbraco.Cms.11.x.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,36 +5,6 @@
<Nullable>enable</Nullable>
<RootNamespace>Umbraco.Cms._11.x</RootNamespace>
</PropertyGroup>
<ItemGroup>
<Content Include="App_Plugins\Umbraco.Community.BlockPreview\css\block-preview.css">
<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
<CopyToPublishDirectory>Always</CopyToPublishDirectory>
</Content>
<Content Include="App_Plugins\Umbraco.Community.BlockPreview\js\controllers\block-preview.controller.js">
<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
<CopyToPublishDirectory>Always</CopyToPublishDirectory>
</Content>
<Content Include="App_Plugins\Umbraco.Community.BlockPreview\js\directives\bind-compile.directive.js">
<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
<CopyToPublishDirectory>Always</CopyToPublishDirectory>
</Content>
<Content Include="App_Plugins\Umbraco.Community.BlockPreview\js\directives\published-check.directive.js">
<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
<CopyToPublishDirectory>Always</CopyToPublishDirectory>
</Content>
<Content Include="App_Plugins\Umbraco.Community.BlockPreview\js\resources\preview.resource.js">
<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
<CopyToPublishDirectory>Always</CopyToPublishDirectory>
</Content>
<Content Include="App_Plugins\Umbraco.Community.BlockPreview\package.manifest">
<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
<CopyToPublishDirectory>Always</CopyToPublishDirectory>
</Content>
<Content Include="App_Plugins\Umbraco.Community.BlockPreview\views\block-preview.html">
<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
<CopyToPublishDirectory>Always</CopyToPublishDirectory>
</Content>
</ItemGroup>

<ItemGroup>
<PackageReference Include="Umbraco.BlockGrid.Example.Website" Version="1.0.2" />
Expand Down

This file was deleted.

This file was deleted.

Loading

0 comments on commit aee651d

Please sign in to comment.