Skip to content

Commit 39e376f

Browse files
crazy-maxcrazy-max
committed
Use mkdocs for documentation (FritzAndFriends#178)
1 parent 2ebcc08 commit 39e376f

Some content is hidden

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

41 files changed

+1053
-999
lines changed

Diff for: ‎.github/workflows/docs.yml

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: docs
2+
3+
on:
4+
push:
5+
branches:
6+
- 'main'
7+
- 'v*'
8+
tags:
9+
- 'v*'
10+
paths:
11+
- '.github/workflows/docs.yml'
12+
- 'docs/**'
13+
- 'mkdocs.yml'
14+
pull_request:
15+
branches:
16+
- 'main'
17+
- 'v*'
18+
paths:
19+
- '.github/workflows/docs.yml'
20+
- 'docs/**'
21+
- 'mkdocs.yml'
22+
23+
jobs:
24+
publish:
25+
runs-on: ubuntu-latest
26+
steps:
27+
-
28+
name: Checkout
29+
uses: actions/checkout@v2
30+
with:
31+
fetch-depth: 0
32+
-
33+
name: Prepare
34+
id: prepare
35+
run: |
36+
VERSION=edge
37+
RELEASE=false
38+
if [[ $GITHUB_REF == refs/tags/* ]]; then
39+
VERSION=${GITHUB_REF#refs/tags/v}
40+
fi
41+
if [[ $VERSION =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
42+
RELEASE=true
43+
fi
44+
echo ::set-output name=release::${RELEASE}
45+
-
46+
name: Build mkdocs Docker image
47+
run: |
48+
docker build -t mkdocs -f ./docs/Dockerfile ./
49+
-
50+
name: Build docs
51+
run: |
52+
docker run --rm -v "$(pwd):/docs" mkdocs build --strict
53+
sudo chown -R $(id -u):$(id -g) ./site
54+
-
55+
name: Check GitHub Pages status
56+
uses: crazy-max/ghaction-github-status@v1
57+
with:
58+
pages_threshold: major_outage
59+
-
60+
name: Deploy
61+
if: success() && github.event_name != 'pull_request' && (endsWith(github.ref, github.event.repository.default_branch) || steps.prepare.outputs.release == 'true')
62+
uses: crazy-max/[email protected]
63+
with:
64+
target_branch: gh-pages
65+
build_dir: site
66+
env:
67+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Diff for: ‎docs/AdRotator.md

-52
This file was deleted.

Diff for: ‎docs/CustomValidator.md

-1
This file was deleted.

Diff for: ‎docs/DataControls/DataList.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
The DataList component is meant to emulate the asp:DataList control in markup and is defined in the [System.Web.UI.WebControls.DataList class](https://docs.microsoft.com/en-us/dotnet/api/system.web.ui.webcontrols.datalist?view=netframework-4.8)
2+
3+
## Features supported in Blazor
4+
5+
- Flow Layout
6+
- Empty List
7+
- FooterStyle
8+
- FooterTemplate
9+
- HeaderStyle
10+
- HeaderTemplate
11+
- Tooltip
12+
- Single Column
13+
- Table Layout
14+
- Accessible Headers
15+
- Empty List
16+
- FooterStyle
17+
- FooterTemplate
18+
- HeaderStyle
19+
- HeaderTemplate
20+
- Tooltip
21+
- Single Column
22+
- Tooltip
23+
24+
## Usage Notes
25+
26+
- The following Web Forms features are ignored
27+
- `runat="server"`
28+
- `EnableViewState`
29+
- `ID` should be converted to `@ref` if the component is referenced in code
30+
- `ItemType` MUST be defined as an attribute
31+
- `Context` should be used to define the object used in templates. If not defined, the default `<INSERT>` will be available.
32+
33+
## Web Forms Declarative Syntax
34+
35+
```html
36+
<asp:DataList
37+
AccessKey="string"
38+
BackColor="color name|#dddddd"
39+
BorderColor="color name|#dddddd"
40+
BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
41+
Inset|Outset"
42+
BorderWidth="size"
43+
Caption="string"
44+
CaptionAlign="NotSet|Top|Bottom|Left|Right"
45+
CellPadding="integer"
46+
CellSpacing="integer"
47+
CssClass="string"
48+
DataKeyField="string"
49+
DataMember="string"
50+
DataSource="string"
51+
DataSourceID="string"
52+
EditItemIndex="integer"
53+
Enabled="True|False"
54+
EnableTheming="True|False"
55+
EnableViewState="True|False"
56+
ExtractTemplateRows="True|False"
57+
Font-Bold="True|False"
58+
Font-Italic="True|False"
59+
Font-Names="string"
60+
Font-Overline="True|False"
61+
Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
62+
Large|X-Large|XX-Large"
63+
Font-Strikeout="True|False"
64+
Font-Underline="True|False"
65+
ForeColor="color name|#dddddd"
66+
GridLines="None|Horizontal|Vertical|Both"
67+
Height="size"
68+
HorizontalAlign="NotSet|Left|Center|Right|Justify"
69+
ID="string"
70+
OnCancelCommand="CancelCommand event handler"
71+
OnDataBinding="DataBinding event handler"
72+
OnDeleteCommand="DeleteCommand event handler"
73+
OnDisposed="Disposed event handler"
74+
OnEditCommand="EditCommand event handler"
75+
OnInit="Init event handler"
76+
OnItemCommand="ItemCommand event handler"
77+
OnItemCreated="ItemCreated event handler"
78+
OnItemDataBound="ItemDataBound event handler"
79+
OnLoad="Load event handler"
80+
OnPreRender="PreRender event handler"
81+
OnSelectedIndexChanged="SelectedIndexChanged event handler"
82+
OnUnload="Unload event handler"
83+
OnUpdateCommand="UpdateCommand event handler"
84+
RepeatColumns="integer"
85+
RepeatDirection="Horizontal|Vertical"
86+
RepeatLayout="Table|Flow"
87+
runat="server"
88+
SelectedIndex="integer"
89+
ShowFooter="True|False"
90+
ShowHeader="True|False"
91+
SkinID="string"
92+
Style="string"
93+
TabIndex="integer"
94+
ToolTip="string"
95+
UseAccessibleHeader="True|False"
96+
Visible="True|False"
97+
Width="size"
98+
>
99+
<AlternatingItemStyle />
100+
<AlternatingItemTemplate>
101+
<!-- child controls -->
102+
</AlternatingItemTemplate>
103+
<EditItemStyle />
104+
<EditItemTemplate>
105+
<!-- child controls -->
106+
</EditItemTemplate>
107+
<FooterStyle />
108+
<FooterTemplate>
109+
<!-- child controls -->
110+
</FooterTemplate>
111+
<HeaderStyle />
112+
<HeaderTemplate>
113+
<!-- child controls -->
114+
</HeaderTemplate>
115+
<ItemStyle />
116+
<ItemTemplate>
117+
<!-- child controls -->
118+
</ItemTemplate>
119+
<SelectedItemStyle />
120+
<SelectedItemTemplate>
121+
<!-- child controls -->
122+
</SelectedItemTemplate>
123+
<SeparatorStyle />
124+
<SeparatorTemplate>
125+
<!-- child controls -->
126+
</SeparatorTemplate>
127+
</asp:DataList>
128+
```
129+
130+
## Blazor Syntax

Diff for: ‎docs/FormView.md renamed to ‎docs/DataControls/FormView.md

-12
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,13 @@
1-
# FormView
2-
31
The FormView component is meant to emulate the asp:FormView control in markup and is defined in the [System.Web.UI.WebControls.FormView class](https://docs.microsoft.com/en-us/dotnet/api/system.web.ui.webcontrols.formview?view=netframework-4.8)
42

5-
[Usage Notes](#usage-notes) | [Web Forms Syntax](#web-forms-declarative-syntax) | [Blazor Syntax](#blazor-syntax)
6-
73
## Features supported in Blazor
84

95
- Readonly Form
106
- Numerical Pager
117
- OnDataBinding and OnDataBound events trigger
128

13-
##### [Back to top](#formview)
14-
159
## Usage Notes
1610

17-
18-
1911
## Web Forms Declarative Syntax
2012

2113
```html
@@ -146,8 +138,4 @@ The FormView component is meant to emulate the asp:FormView control in markup an
146138
</asp:FormView>
147139
```
148140

149-
##### [Back to top](#formview)
150-
151141
## Blazor Syntax
152-
153-
##### [Back to top](#formview)

0 commit comments

Comments
 (0)