Skip to content

Commit dc0c6fc

Browse files
committed
overview page updated
1 parent 47c1879 commit dc0c6fc

File tree

2 files changed

+32
-51
lines changed

2 files changed

+32
-51
lines changed

docs/index.md

+27-46
Original file line numberDiff line numberDiff line change
@@ -2,66 +2,60 @@
22
title: Overview
33
social:
44
cards_layout_options:
5-
title: Documentation that simply works
5+
title: WpDotNet - WordPress on .NET - Overview
66
---
77

88
# Overview
99

10-
[WpDotNet](https://wpdotnet.peachpie.io/) is the unmodified WordPress, running compiled purely on .NET, provided as a NuGet package & ready to be used as a part of an ASP NET Core application. WpDotNet comes with additional components and features, making it easy to be used from C# and a .NET development environment in general.
10+
[WpDotNet](https://www.wpdotnet.com/) is the unmodified WordPress, running compiled purely on .NET, provided as a NuGet package & ready to be used as a part of an ASP NET Core application. WpDotNet comes with additional components and features, making it easy to be used from C# and a .NET development environment in general.
1111

1212
The project does not require PHP to be installed, and is purely built on top of the .NET platform.
1313

14-
## Requirements
14+
## Prerequisites
1515

16-
- .NET SDK 6.0, or newer. ([dotnet.microsoft.com](https://dotnet.microsoft.com/download) or [visualstudio.microsoft.com](https://visualstudio.microsoft.com/vs/))
16+
- .NET SDK 6.0, or newer. ([dotnet.microsoft.com](https://dotnet.microsoft.com/download))
1717
- MySQL Server ([dev.mysql.com](https://dev.mysql.com/downloads/mysql/) or [docker](https://hub.docker.com/_/mysql))
1818

1919
Make sure you have valid credentials to your MySQL server and you have created a database in it. The following quick start expects a database named `"wordpress"`. Database charset `"UTF-8"` is recommended.
2020

2121
## Quick Start
2222

23-
> The sources of a demo WordPress application are available at [github.com/iolevel/peachpie-wordpress](https://github.com/iolevel/peachpie-wordpress).
23+
Open or create an ASP NET Core application, version 6.0 or newer.
2424

25-
Open or create an ASP NET Core application, version 3.0 or newer.
25+
```shell
26+
dotnet new web
27+
```
2628

2729
Add a package reference to [`"Peachpied.WordPress.AspNetCore"`](https://www.nuget.org/packages/PeachPied.WordPress.AspNetCore/) (note it is a **pre-release** package):
2830

2931
```shell
3032
dotnet add package PeachPied.WordPress.AspNetCore --version 6.5.4-rc-020
3133
```
3234

33-
Add the WordPress middleware within your request pipeline, in the `Configure` startup method:
35+
Add the WordPress services and set up your database connection (here or in `appsettings.json`):
3436

3537
```C#
36-
public partial class Startup
38+
builder.Services.AddWordPress(options =>
3739
{
38-
public void Configure(IApplicationBuilder app)
39-
{
40-
// ...
41-
app.UseWordPress();
42-
// ...
43-
}
44-
}
40+
options.DbHost = "localhost";
41+
options.DbName = "wordpress";
42+
// ...
43+
});
4544
```
4645

47-
Add the WordPress option service within the `ConfigureServices` startup method and set up your database connection and other options:
46+
> Note: the recommended approach is to place the configuration within the `appsettings.json` configuration file. See [configuration](configuration) for more details.
47+
48+
Add the WordPress middleware within your request pipeline:
4849

4950
```C#
50-
public partial class Startup
51-
{
52-
public void ConfigureServices(IServiceCollection services)
53-
{
54-
services.AddWordPress(options =>
55-
{
56-
options.DbHost = "localhost";
57-
options.DbName = "wordpress";
58-
// ...
59-
});
60-
}
61-
}
51+
// ...
52+
app.UseWordPress();
53+
// ...
6254
```
6355

64-
> Note: the recommended approach is to place the configuration within the `appsettings.json` configuration file. See [configuration](configuration.md) for more details.
56+
## Sample App
57+
58+
The sources of a demo WordPress application are available at [github.com/iolevel/peachpie-wordpress](https://github.com/iolevel/peachpie-wordpress).
6559

6660
## Dashboard
6761

@@ -71,29 +65,16 @@ Besides regular WordPress dashboard pages, WpDotNet adds an informational panel
7165

7266
The panel provides information about the current .NET runtime version, consumed memory, or total CPU time spent in the whole application. Note that the values are reset if the process is restarted.
7367

74-
## Registration
75-
76-
Go to the **At a Glance** panel in the WordPress Dashboard. The current registration information is displayed next the to **License:** label.
77-
78-
- **Register** opens a dialog to enter the e-mail you provided when purchasing your subscription, or the license key we issued if you have a custom build.
79-
- **Purchase** opens the web page where you can buy your WpDotNet subscription.
80-
81-
The registration is bound to the host name of the domain you are running WpDotNet on.
82-
83-
![watermark](img/watermark.png)
84-
85-
You can use WpDotNet with all of its functionality without purchasing a subscription, but your pages will include a small watermark. To remove it, please register your WpDotNet subscription.
86-
8768
## Remarks
8869

8970
- Permalinks are implicitly enabled through the URL rewriting feature.
90-
- WordPress debugging is implicitly enabled when running in a *Development* environment.
91-
- When running on Azure with MySql in App enabled, the database connection is automatically configured.
92-
- Response caching and response compression are enabled by default.
71+
- WordPress debugging is implicitly enabled when running in a *Development* environment (debugging in your IDE).
72+
- When running on Azure Web App with _MySql in App_ enabled, the database connection is automatically configured.
73+
- Response caching and response compression are enabled by default when user is not logged in.
9374
- Most of the original `.php` files are not present on the file system and cannot be edited.
9475

9576
## Related links
9677

97-
- https://wpdotnet.peachpie.io/
78+
- https://www.wpdotnet.com/
9879
- https://www.nuget.org/packages/PeachPied.WordPress.AspNetCore/
9980
[![NuGet](https://img.shields.io/nuget/v/PeachPied.WordPress.AspNetCore.svg)](https://www.nuget.org/packages/PeachPied.WordPress.AspNetCore/)

mkdocs.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ site_name: WpDotNet - WordPress on .NET
33
site_url: https://www.wpdotnet.com/
44
site_author: PeachPie Team
55
site_description: >-
6-
This site provides WpDotNet project documentation and useful tips.
6+
This site provides WpDotNet project documentation.
77
88
# Repository
99
repo_name: iolevel/wpdotnet
@@ -17,8 +17,8 @@ theme:
1717
name: material
1818
features:
1919
- announce.dismiss
20-
#- content.action.edit
21-
#- content.action.view
20+
- content.action.edit
21+
- content.action.view
2222
- content.code.annotate
2323
- content.code.copy
2424
- content.code.select
@@ -93,9 +93,9 @@ extra:
9393
generator: false
9494
social:
9595
- icon: fontawesome/brands/github
96-
link: https://github.com/peachpiecompiler
96+
link: https://github.com/iolevel/wpdotnet-sdk
9797
- icon: fontawesome/brands/x-twitter
98-
link: https://x.com/pchpcompiler
98+
link: https://x.com/pchpcompiler
9999
- icon: fontawesome/brands/facebook
100100
link: https://facebook.com/pchpcompiler
101101
- icon: fontawesome/brands/youtube

0 commit comments

Comments
 (0)