Merge branch 'crazy-max-mkdocs' into dev

FritzAndFriends · Aug 2, 2020 · 38b3e3e · 38b3e3e
2 parents fc935fc + f7d18dc
commit 38b3e3e
Show file tree

Hide file tree

Showing 47 changed files with 1,078 additions and 1,024 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,67 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'v*'
+    tags:
+      - 'v*'
+    paths:
+      - '.github/workflows/docs.yml'
+      - 'docs/**'
+      - 'mkdocs.yml'
+  pull_request:
+    branches:
+      - 'main'
+      - 'v*'
+    paths:
+      - '.github/workflows/docs.yml'
+      - 'docs/**'
+      - 'mkdocs.yml'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      -
+        name: Prepare
+        id: prepare
+        run: |
+          VERSION=edge
+          RELEASE=false
+          if [[ $GITHUB_REF == refs/tags/* ]]; then
+            VERSION=${GITHUB_REF#refs/tags/v}
+          fi
+          if [[ $VERSION =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
+            RELEASE=true
+          fi
+          echo ::set-output name=release::${RELEASE}
+      -
+        name: Build mkdocs Docker image
+        run: |
+          docker build -t mkdocs -f ./docs/Dockerfile ./
+      -
+        name: Build docs
+        run: |
+          docker run --rm -v "$(pwd):/docs" mkdocs build --strict
+          sudo chown -R $(id -u):$(id -g) ./site
+      -
+        name: Check GitHub Pages status
+        uses: crazy-max/ghaction-github-status@v1
+        with:
+          pages_threshold: major_outage
+      -
+        name: Deploy
+        if: success() && github.event_name != 'pull_request' && (endsWith(github.ref, 'main') || steps.prepare.outputs.release == 'true')
+        uses: crazy-max/[email protected]
+        with:
+          target_branch: gh-pages
+          build_dir: site
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/docs/AdRotator.md b/docs/AdRotator.md
diff --git a/docs/CustomValidator.md b/docs/CustomValidator.md
diff --git a/docs/DataControls/DataList.md b/docs/DataControls/DataList.md
@@ -0,0 +1,130 @@
+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)
+
+## Features supported in Blazor
+
+- Flow Layout
+    - Empty List
+    - FooterStyle
+    - FooterTemplate
+    - HeaderStyle
+    - HeaderTemplate
+    - Tooltip
+    - Single Column
+ - Table Layout
+    - Accessible Headers
+    - Empty List
+    - FooterStyle
+    - FooterTemplate
+    - HeaderStyle
+    - HeaderTemplate
+    - Tooltip
+    - Single Column
+    - Tooltip
+
+## Usage Notes
+
+- The following Web Forms features are ignored
+    - `runat="server"`
+    - `EnableViewState`
+- `ID` should be converted to `@ref` if the component is referenced in code
+- `ItemType` MUST be defined as an attribute
+- `Context` should be used to define the object used in templates.  If not defined, the default `<INSERT>` will be available.
+
+## Web Forms Declarative Syntax
+
+```html
+<asp:DataList
+    AccessKey="string"
+    BackColor="color name|#dddddd"
+    BorderColor="color name|#dddddd"
+    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
+        Inset|Outset"
+    BorderWidth="size"
+    Caption="string"
+    CaptionAlign="NotSet|Top|Bottom|Left|Right"
+    CellPadding="integer"
+    CellSpacing="integer"
+    CssClass="string"
+    DataKeyField="string"
+    DataMember="string"
+    DataSource="string"
+    DataSourceID="string"
+    EditItemIndex="integer"
+    Enabled="True|False"
+    EnableTheming="True|False"
+    EnableViewState="True|False"
+    ExtractTemplateRows="True|False"
+    Font-Bold="True|False"
+    Font-Italic="True|False"
+    Font-Names="string"
+    Font-Overline="True|False"
+    Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
+        Large|X-Large|XX-Large"
+    Font-Strikeout="True|False"
+    Font-Underline="True|False"
+    ForeColor="color name|#dddddd"
+    GridLines="None|Horizontal|Vertical|Both"
+    Height="size"
+    HorizontalAlign="NotSet|Left|Center|Right|Justify"
+    ID="string"
+    OnCancelCommand="CancelCommand event handler"
+    OnDataBinding="DataBinding event handler"
+    OnDeleteCommand="DeleteCommand event handler"
+    OnDisposed="Disposed event handler"
+    OnEditCommand="EditCommand event handler"
+    OnInit="Init event handler"
+    OnItemCommand="ItemCommand event handler"
+    OnItemCreated="ItemCreated event handler"
+    OnItemDataBound="ItemDataBound event handler"
+    OnLoad="Load event handler"
+    OnPreRender="PreRender event handler"
+    OnSelectedIndexChanged="SelectedIndexChanged event handler"
+    OnUnload="Unload event handler"
+    OnUpdateCommand="UpdateCommand event handler"
+    RepeatColumns="integer"
+    RepeatDirection="Horizontal|Vertical"
+    RepeatLayout="Table|Flow"
+    runat="server"
+    SelectedIndex="integer"
+    ShowFooter="True|False"
+    ShowHeader="True|False"
+    SkinID="string"
+    Style="string"
+    TabIndex="integer"
+    ToolTip="string"
+    UseAccessibleHeader="True|False"
+    Visible="True|False"
+    Width="size"
+>
+        <AlternatingItemStyle />
+        <AlternatingItemTemplate>
+            <!-- child controls -->
+        </AlternatingItemTemplate>
+        <EditItemStyle />
+        <EditItemTemplate>
+            <!-- child controls -->
+        </EditItemTemplate>
+        <FooterStyle />
+        <FooterTemplate>
+            <!-- child controls -->
+        </FooterTemplate>
+        <HeaderStyle />
+        <HeaderTemplate>
+            <!-- child controls -->
+        </HeaderTemplate>
+        <ItemStyle />
+        <ItemTemplate>
+            <!-- child controls -->
+        </ItemTemplate>
+        <SelectedItemStyle />
+        <SelectedItemTemplate>
+            <!-- child controls -->
+        </SelectedItemTemplate>
+        <SeparatorStyle />
+        <SeparatorTemplate>
+            <!-- child controls -->
+        </SeparatorTemplate>
+</asp:DataList>
+```
+
+## Blazor Syntax
diff --git a/docs/FormView.md → docs/DataControls/FormView.md b/docs/FormView.md → docs/DataControls/FormView.md
@@ -1,21 +1,13 @@
-# FormView
-
 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)
 
-[Usage Notes](#usage-notes) | [Web Forms Syntax](#web-forms-declarative-syntax) | [Blazor Syntax](#blazor-syntax)
-
 ## Features supported in Blazor
 
   - Readonly Form
   - Numerical Pager
   - OnDataBinding and OnDataBound events trigger
 
-##### [Back to top](#formview)
-
 ## Usage Notes
 
-
-
 ## Web Forms Declarative Syntax
 
 ```html
@@ -146,8 +138,4 @@ The FormView component is meant to emulate the asp:FormView control in markup an
 </asp:FormView>
 ```
 
-##### [Back to top](#formview)
-
 ## Blazor Syntax
-
-##### [Back to top](#formview)