Skip to content

Commit 1826961

Browse files
ntachevanikolay-nenkovxristianstefanovVelinovAngela-d-atanasov
authored
docs(common): Migrate to docs-builder (#2476)
* adding docs builder config and content fixes * chore(common): fix malformed code block tags * chore(common): fix broken links * chore(common): fix broken code blocks * chore(common): fix broken links * chore(common): fix links: * chore(common): fix links * chore(common): fix links * chore(common): fix links * chore(common): fix links * chore(common): fix links * docs: changed primary-color to purple * chore(common): fix links * chore(common): fix links * chore(common): fix links * chore(common): fix broken relative link * chore(common): fix no code block language errors * chore(common): fix no code block language errors * chore(common): fix no language errors * chore(common): fix broken blocks of code * chore(common): cannot find gramar fixes * chore(common): fix broken code blocks * chore(common): add latest fixes from the excel file * chore(common): fix tables in breaking changes articles and remaining warnings * chore(common): fix latest warnings * chore(common): fix unresolved urls * chore(common): fix link * adding docs builder interpolation settings * chore(common): fix remaining links * chore(common) fix broken nested ol's * Add blazor-repl prop in config * adding metadata-config for docfx * Fix some md files with wrong skip-repl * fixing broken api ref link * Removed system.object inherited members and datasource expressions broken regex * fixed codeblock with unescaped interpolation * Fix: Fix some wrong MD files * close code block * Fix: Fix some wrong MD files * fixing api ref links * fixing trial link * added theme version to liquid vars * fix metadata * fixing nav items ordering * fixed links * fixing a11y links * added pdf cover * applied latest nav changes * fixing broken markdown content * fixing broken code block * Add intro-page table * changing primary color * fix tabbed code blocks + headings * Fix: Some code blocks were Repl * Fix: Some wrong codeblocks * Fix: Some wrong codeblocks * Fix: Some wrong codeblocks * Fix: Some wrong codeblocks * Fix: worng codeblock language * Fix some REPL to codeblocks * Fix come codeblocks to REPL * Fix: wrong tabbed code block * Fix ninja-avatar icon * chore(common): skip repl in snippets * chore(Gantt): fix snippets and skip repl * chore(Grid,Gauge): fix snippets and skip repl * chore(common): fix snippets * chore(treelist): fix snippets * chore(docs): fixing broken links * Replace CSHTML with RAZOR * Fix code snippets --------- Co-authored-by: Nikolay Nenkov <[email protected]> Co-authored-by: Hristian Stefanov <[email protected]> Co-authored-by: AngelVelinov <[email protected]> Co-authored-by: Atanas Atanasov <[email protected]> Co-authored-by: Dimo Dimov <[email protected]>
1 parent 663a8dc commit 1826961

File tree

1,197 files changed

+4566
-3689
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,197 files changed

+4566
-3689
lines changed

_assetsApi/filterConfig.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@ apiRules:
1313
- exclude:
1414
uidRegex: ^Telerik\.DataSource\.IDescriptor$
1515
- exclude:
16-
uidRegex: ^Telerik\.DataSource\.Expressions\.*$
16+
uidRegex: ^Telerik\.DataSource\.Expressions\..*$
1717
- exclude:
1818
uidRegex: ^Telerik\.DataSource\.\w*Node
1919
- exclude:
2020
uidRegex: ^Telerik\.DataSource\.\w*Expression\w*$
2121
- exclude:
2222
uidRegex: ^Telerik\.DataSource\.\w+Aggregate\w*$
2323
- exclude:
24-
uidRegex: ^Telerik.Blazor.Components.ToolBarw*$
24+
type: Method
25+
uidRegex: ^System\.Object\..*$

_assetsApi/metadata-config.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"metadata": [{
3+
"src": [
4+
{
5+
"files": [
6+
"src/**.dll"
7+
]
8+
}
9+
],
10+
"dest": "metadata",
11+
"filter": "filterConfig.yml"
12+
}]
13+
}

_contentTemplates/chart/link-to-basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This article assumes you are familiar with the [chart basics]({%slug components/
77

88
Bar and Column charts can take the color of the series item from the `ColorField` of the data source. You can pass a valid CSS color (for example, `#abcdef`, `#f00`, or `blue`).
99

10-
````CSHTML
10+
````RAZOR
1111
Colors per series item
1212
1313
<TelerikChart>

_contentTemplates/common/format-placeholders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ By default the value for all parameters would be `null`, the full format specifi
2424

2525
>caption Provide a custom string to the day, month, and year segments
2626
27-
````CSHTML
27+
````RAZOR
2828
@* Provide custom rendering of the day, month, and year segments *@
2929
3030
<TelerikDatePicker @bind-Value="@DateValue">
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#get-model-from-dropdowns
2-
>tip If you are looking for more fields from the view-model that describes the dropdown items, not just the `Value`, see the [Get model from dropdown]({%slug dropdowns-get-model%}) KB article and the [OnChange](events#onchange) event.
2+
>tip If you are looking for more fields from the view-model that describes the dropdown items, not just the `Value`, see the [Get model from dropdown]({%slug dropdowns-get-model%}) KB article and the [OnChange](../events#onchange) event.
33
>
44
> You may also want to review/join the discussion and Vote for this request: <a href="https://www.telerik.com/forums/binding-dropdownlist-value-to-complex-model" target="_blank">Binding DropDownList Value to complex model</a>
55
#end

_contentTemplates/common/get-started.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ In this tutorial, you will use the [Telerik NuGet feed]({%slug installation/nuge
3535

3636
1. Add the `https://nuget.telerik.com/v3/index.json` URL as a **Source**. Click **OK**.
3737

38-
![Add the Telerik NuGet Feed in Visual Studio](images/telerik-nuget-feed.png)
38+
![Add the Telerik NuGet Feed in Visual Studio](images/telerik-nuget-feed.png)
3939

4040
1. Whenever Visual Studio displays a dialog to enter credentials for `nuget.telerik.com`, use your Telerik account email and password.
4141

@@ -46,36 +46,36 @@ In this tutorial, you will use the [Telerik NuGet feed]({%slug installation/nuge
4646

4747
#add-component-sample
4848

49-
**RAZOR**
50-
51-
<TelerikButton>Say Hello</TelerikButton>
52-
53-
1. Optionally, hook up a click handler that will show a message. The resulting view will look like this:
54-
55-
**RAZOR**
56-
57-
@page "/"
58-
59-
<TelerikButton ThemeColor="@ThemeConstants.Button.ThemeColor.Primary"
60-
OnClick="@SayHelloHandler">Say Hello</TelerikButton>
61-
62-
<p>@HelloString</p>
49+
````RAZOR.skip-repl
50+
<TelerikButton>Say Hello</TelerikButton>
51+
````
6352

64-
@code {
65-
private MarkupString HelloString { get; set; }
66-
67-
private void SayHelloHandler()
68-
{
69-
string msg = $"Hello from <strong>Telerik UI for Blazor</strong> at {DateTime.Now.ToString("HH:mm:ss")}!" +
70-
"<br /> Now you can use C# to write front-end!";
53+
1. Optionally, hook up a click handler that will show a message. The resulting view will look like this:
7154

72-
HelloString = new MarkupString(msg);
73-
}
74-
}
55+
````RAZOR.skip-repl
56+
@page "/"
57+
58+
<TelerikButton ThemeColor="@ThemeConstants.Button.ThemeColor.Primary"
59+
OnClick="@SayHelloHandler">Say Hello</TelerikButton>
60+
61+
<p>@HelloString</p>
62+
63+
@code {
64+
private MarkupString HelloString { get; set; }
65+
66+
private void SayHelloHandler()
67+
{
68+
string msg = $"Hello from <strong>Telerik UI for Blazor</strong> at {DateTime.Now.ToString("HH:mm:ss")}!" +
69+
"<br /> Now you can use C# to write front-end!";
70+
71+
HelloString = new MarkupString(msg);
72+
}
73+
}
74+
````
7575

7676
1. Run the app in the browser. You should see something like this:
7777

78-
![Telerik Blazor app in the browser](images/blazor-app-in-browser.png)
78+
![Telerik Blazor app in the browser](images/blazor-app-in-browser.png)
7979

8080
Well done! Now you have your first Telerik UI for Blazor component running in your Blazor app.
8181

@@ -138,7 +138,7 @@ Add a `<TelerikRootComponent>` to the app layout file (by default, `MainLayout.r
138138
139139
<div class="skip-repl"></div>
140140

141-
````CSHTML
141+
````RAZOR
142142
@inherits LayoutComponentBase
143143
144144
<TelerikRootComponent>

_contentTemplates/common/inputs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Consider setting `DebounceDelay="0"` to the component inside the editor template
1313

1414
The component allows you to add custom elements as prefixes and suffixes. [Read more about how to render custom adornments before and after the input element...]({%slug common-features/input-adornments%})
1515
#end
16-
16+
1717
#floating-label-and-preffix
18-
When using the [`PrefixTemplate`]({%slug common-features/input-adornments%}#adding-prefix-in-ui-for-blazor-components) for a component wrapped in a [FloatingLabel]({%slug floatinglabel-overview%}), the label will overlap the prefix.
18+
When using the [`PrefixTemplate`]({%slug common-features/input-adornments%}#adding-a-prefix-adornment) for a component wrapped in a [FloatingLabel]({%slug floatinglabel-overview%}), the label will overlap the prefix.
1919

2020
To ensure both the FloatingLabel and the prefix content are properly displayed, move the label with CSS:
2121

22-
````CSHTML
22+
````RAZOR
2323
<style>
2424
.custom-label-class .k-floating-label {
2525
margin-left: 30px;

_contentTemplates/common/js-interop-file.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#end
2121

2222
#js-interop-file-snippet
23-
````
23+
````HTML
2424
<head>
2525
. . .
2626
<script src="_content/Telerik.UI.for.Blazor/js/telerik-blazor.js"></script>
@@ -33,7 +33,7 @@
3333
#end
3434

3535
#theme-static-asset-snippet
36-
````
36+
````HTML
3737
<head>
3838
. . .
3939
<link rel="stylesheet" href="_content/Telerik.UI.for.Blazor/css/kendo-theme-default/all.css" />
@@ -47,7 +47,7 @@
4747

4848
#register-telerik-service-server
4949
<div class="skip-repl"></div>
50-
````
50+
````C#
5151
// ...
5252
5353
var builder = WebApplication.CreateBuilder(args);
@@ -64,7 +64,7 @@ var app = builder.Build();
6464

6565
#register-telerik-service-client
6666
<div class="skip-repl"></div>
67-
````.NET_6_and_.NET_7
67+
````C#
6868
using ClientBlazorProject;
6969
using Microsoft.AspNetCore.Components.Web;
7070
using Microsoft.AspNetCore.Components.WebAssembly.Hosting;

_contentTemplates/grid/common-link.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55

66
#conditional-style-row-and-cell-render
7-
````CSHTML
7+
````RAZOR
88
@* Conditional styling/formatting for a cell and row *@
99
1010
<style>
@@ -171,7 +171,8 @@ A multi-header column does not show up in the list of columns in the column choo
171171

172172
The state of a multi-header column is handled in the same way as a standard column. The columns in the state are listed in a flat list in the order of definition. For example, for the following setup:
173173

174-
````CSHTML
174+
<div class="skip-repl"></div>
175+
````RAZOR
175176
<TelerikGrid>
176177
<GridColumns>
177178
<GridColumn Title="column 1">

_contentTemplates/grid/export.md

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -9,70 +9,70 @@
99

1010
* With Server-side Blazor, the file may become larger than the default SignalR connection limit, and this can disconnect the client and result in an error. Generally, this requires quite a lot of data to happen, but you may need to increase the size limit of the connection in the `ConfigureServices` method of your `Startup.cs` file, for example:
1111

12-
**C#**
13-
14-
services.AddServerSideBlazor().AddHubOptions(o =>
15-
{
16-
o.MaximumReceiveMessageSize = 1024 * 1024; // 1MB
17-
});
12+
````C#.skip-repl
13+
services.AddServerSideBlazor().AddHubOptions(o =>
14+
{
15+
o.MaximumReceiveMessageSize = 1024 * 1024; // 1MB
16+
});
17+
````
1818

1919
* With Client-side Blazor (WebAssembly), all the code runs in the browser and, at the time of writing, is considerably slower than server-side Blazor, and it only has one actual thread. This means that while the file is being generated, the UI will be unresponsive, so you may want to show a loading sign to the user through the `OnClick` handler of the command button, something like:
2020

21-
**Component**
22-
23-
@* Exporting a lot of rows can be slow in a WebAssembly app more so than in a server-side app, and it blocks the UI *@
21+
````RAZOR.skip-repl Component
22+
@* Exporting a lot of rows can be slow in a WebAssembly app more so than in a server-side app, and it blocks the UI *@
2423
25-
<TelerikGrid Data="@GridData" AutoGenerateColumns="true" Pageable="true">
26-
<GridToolBarTemplate>
27-
<GridCommandButton OnClick="@ShowLoadingSign" Command="ExcelExport" Icon="@SvgIcon.FileExcel">Export to Excel</GridCommandButton>
28-
<GridCommandButton OnClick="@ShowLoadingSign" Command="CsvExport" Icon="@SvgIcon.FileCsv">Export to CSV</GridCommandButton>
29-
</GridToolBarTemplate>
30-
<GridExport>
31-
<GridExcelExport AllPages="true" FileName="telerik-grid-export" />
32-
<GridCsvExport AllPages="true" FileName="telerik-grid-export" />
33-
</GridExport>
34-
</TelerikGrid>
24+
<TelerikGrid Data="@GridData" AutoGenerateColumns="true" Pageable="true">
25+
<GridToolBarTemplate>
26+
<GridCommandButton OnClick="@ShowLoadingSign" Command="ExcelExport" Icon="@SvgIcon.FileExcel">Export to Excel</GridCommandButton>
27+
<GridCommandButton OnClick="@ShowLoadingSign" Command="CsvExport" Icon="@SvgIcon.FileCsv">Export to CSV</GridCommandButton>
28+
</GridToolBarTemplate>
29+
<GridExport>
30+
<GridExcelExport AllPages="true" FileName="telerik-grid-export" />
31+
<GridCsvExport AllPages="true" FileName="telerik-grid-export" />
32+
</GridExport>
33+
</TelerikGrid>
3534
36-
<TelerikWindow Visible="@isExporting" Modal="true">
37-
<WindowTitle>Please wait...</WindowTitle>
38-
<WindowContent>We are exporting your data, your file will download shortly.</WindowContent>
39-
</TelerikWindow>
35+
<TelerikWindow Visible="@isExporting" Modal="true">
36+
<WindowTitle>Please wait...</WindowTitle>
37+
<WindowContent>We are exporting your data, your file will download shortly.</WindowContent>
38+
</TelerikWindow>
4039
41-
@code {
42-
bool isExporting { get; set; }
40+
@code {
41+
bool isExporting { get; set; }
4342
44-
async Task ShowLoadingSign()
45-
{
46-
isExporting = true;
47-
StateHasChanged();
48-
// This won't work for server-side Blazor, the UI will render immediately after the delay and the loading sign will only flicker
49-
await Task.Delay(50);
50-
isExporting = false;
51-
}
43+
async Task ShowLoadingSign()
44+
{
45+
isExporting = true;
46+
StateHasChanged();
47+
// This won't work for server-side Blazor, the UI will render immediately after the delay and the loading sign will only flicker
48+
await Task.Delay(50);
49+
isExporting = false;
50+
}
5251
53-
List<SampleData> GridData { get; set; }
52+
List<SampleData> GridData { get; set; }
5453
55-
protected override void OnInitialized()
56-
{
57-
GridData = Enumerable.Range(1, 1000).Select(x => new SampleData
58-
{
59-
ProductId = x,
60-
ProductName = $"Product {x}",
61-
UnitsInStock = x * 2,
62-
Price = 3.14159m * x,
63-
Discontinued = x % 4 == 0,
64-
FirstReleaseDate = DateTime.Now.AddDays(-x)
65-
}).ToList();
66-
}
54+
protected override void OnInitialized()
55+
{
56+
GridData = Enumerable.Range(1, 1000).Select(x => new SampleData
57+
{
58+
ProductId = x,
59+
ProductName = $"Product {x}",
60+
UnitsInStock = x * 2,
61+
Price = 3.14159m * x,
62+
Discontinued = x % 4 == 0,
63+
FirstReleaseDate = DateTime.Now.AddDays(-x)
64+
}).ToList();
65+
}
6766
68-
public class SampleData
69-
{
70-
public int ProductId { get; set; }
71-
public string ProductName { get; set; }
72-
public int UnitsInStock { get; set; }
73-
public decimal Price { get; set; }
74-
public bool Discontinued { get; set; }
75-
public DateTime FirstReleaseDate { get; set; }
76-
}
77-
}
67+
public class SampleData
68+
{
69+
public int ProductId { get; set; }
70+
public string ProductName { get; set; }
71+
public int UnitsInStock { get; set; }
72+
public decimal Price { get; set; }
73+
public bool Discontinued { get; set; }
74+
public DateTime FirstReleaseDate { get; set; }
75+
}
76+
}
77+
````
7878
#end

_contentTemplates/rootcomponent/setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99
1010
<div class="skip-repl"></div>
1111

12-
````TelerikLayout.razor
12+
````RAZOR TelerikLayout.razor
1313
@inherits LayoutComponentBase
1414
1515
<TelerikRootComponent>
1616
@Body
1717
</TelerikRootComponent>
1818
````
19-
````MainLayout.razor
19+
````RAZOR MainLayout.razor
2020
@inherits LayoutComponentBase
2121
@layout TelerikLayout
2222

0 commit comments

Comments
 (0)