@lowdefy/docs 3.22.0 → 3.23.2

package/templates/blocks/exampleTransformer.js

@@ -57,7 +57,7 @@ ${example.description || ''}
               _nunjucks: {
                 template: `
 \`\`\`yaml
-{{ block }}
+{{ block | safe }}
 \`\`\`
 `,
                 on: {

package/templates/blog.yaml.njk

@@ -0,0 +1,221 @@
+# Copyright 2020-2021 Lowdefy, Inc
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+id: "{{ pageId }}"
+type: PageHeaderMenu
+requests:
+  - id: post_telemetry
+    type: AxiosHttp
+    connectionId: lowdefy_api_telemetry
+    properties:
+      data:
+        session_id:
+          _global: session_id
+        page_id:
+          _var: pageId
+        url_query:
+          _url_query: true
+        input:
+          _input: true
+
+events:
+  onInit:
+    - id: set_session_id
+      type: SetGlobal
+      skip:
+        _not:
+          _eq:
+            - _global: session_id
+            - null
+      params:
+        session_id:
+          _random:
+            type: string
+            length: 16
+  onEnterAsync:
+    - id: connect_docsearch
+      type: JsAction
+      params:
+        name: connectDocsearch
+    - id: post_telemetry
+      type: Request
+      messages:
+        error: false
+      params: post_telemetry
+
+properties:
+  title: {{ pageTitle }}
+  header:
+    theme: light
+  menu:
+    forceSubMenuRender: true
+    links: []
+  sider:
+    width: 256px
+    initialCollapsed:
+      _or:
+        - _eq:
+            - _media: size
+            - md
+        - _eq:
+            - _media: size
+            - lg
+  content:
+    style:
+      background: '#FFFFFF'
+  footer:
+    style:
+      background: '#FFFFFF'
+      padding: 16px 0px 0px 0px
+areas:
+  header:
+    blocks:
+      _ref: templates/header.yaml
+  footer:
+    blocks:
+      _ref:
+        path: templates/footer.yaml.njk
+        vars:
+          hideFeedback:
+            _var: hideFeedback
+          filePath:
+            _var: filePath
+          pageId:
+            _var: pageId
+          padding: 40
+
+  content:
+    justify: center
+    blocks:
+      - id: affix_breadcrumb
+        type: Affix
+        style:
+          background: '#FFFFFF'
+        blocks:
+          - id: breadcrumb
+            type: Breadcrumb
+            style:
+              background: '#FFFFFF'
+              margin: 0px -32px 0px -32px
+              padding: 8px 32px 8px 32px
+            properties:
+              list:
+                - label:
+                    _ref: version.yaml
+                  pageId: introduction
+                - label: Lowdefy Docs
+                  pageId: introduction
+            {% if section %}
+                - {{ section }}
+                - {{ pageTitle }}
+            {% endif %}
+      {% if pageImage %}
+      - id: page_image
+        type: Img
+        style:
+          marginLeft: -50
+        properties:
+          src:
+            _var: pageImage
+          alt:
+            _var: pageTitle
+          width: 105%
+      {% endif %}
+      - id: max_width
+        type: Box
+        layout:
+          flex: 0 1 800px
+          contentGutter: 16
+        style:
+          marginTop: 32
+        blocks:
+          {% if pageTitle %}
+          - id: page_title
+            type: Title
+            properties:
+              content:
+                _var: pageTitle
+          {% endif %}
+          - id: content
+            type: Box
+            layout:
+              contentGutter: 16
+            blocks:
+              _var: content
+          {% if discussionsLink %}
+          - id: md5
+            type: MarkdownWithCode
+            properties:
+              content: |
+                -----
+                ###### Comments and questions regarding this how-to are availible on [this GitHub Discussions Thread]({{ discussionsLink }})
+
+          {% endif %}
+          - id: footer_links
+            type: MarkdownWithCode
+            properties:
+              content: |
+                -----
+          - id: links_box
+            type: Box
+            layout:
+              span: 12
+              contentGutter: 16
+            blocks:
+              - id: md_author
+                type: MarkdownWithCode
+                properties:
+                  content: |
+                    ###### Other interesting how-to guides:
+              {% for item in articleLinks %}
+              - id: links-{{ item.pageId }}
+                type: Anchor
+                properties:
+                  icon: LinkOutlined
+                  href: /{{ item.pageId }}
+                  title: {{ item.title }}
+              {% endfor %}
+
+          {% if authorName %}
+          - id: author_box
+            type: Box
+            layout:
+              span: 12
+              contentGutter: 16
+            blocks:
+              - id: md_author
+                type: MarkdownWithCode
+                properties:
+                  content: |
+                    ###### This how-to article was written by:
+              {% if authorProfile %}
+              - id: author
+                type: Avatar
+                layout:
+                  flex: 0 1 auto
+                properties:
+                  src:
+                    _var: authorProfile
+                  size: large
+              {% endif %}
+              - id: author_name
+                type: Html
+                style:
+                  marginTop: -3
+                layout:
+                  flex: 1 0 auto
+                properties:
+                  html:
+                    _var: authorName
+          {% endif %}

package/templates/footer.yaml.njk

@@ -262,6 +262,8 @@
   type: Box
   layout:
     contentGutter: 46
+  style:
+    paddingLeft: 23px
   blocks:
     - id: footer_logo_box
       type: Box
@@ -600,5 +602,3 @@
           properties:
             html: |
               <div style="text-align: center; font-size: 12px; margin-top: 42px;">© 2021 Lowdefy, Inc. - Give. Easy. Value.</div>
-
-

package/tutorial/tutorial-create-page.yaml

@@ -76,7 +76,7 @@ _ref:
 
             ```yaml
             name: lowdefy-project-template
-            lowdefy: 3.22.0
+            lowdefy: 3.23.2
 
             pages:
             ################ -------- Copy from here -------- ################

package/tutorial/tutorial-start.yaml

@@ -180,7 +180,7 @@ _ref:
             Open the `lowdefy.yaml` file using a text editor like [VS Code](https://code.visualstudio.com/download). The content of the file should look like this:
 
             ```yaml
-            lowdefy: 3.22.0
+            lowdefy: 3.23.2
             name: Lowdefy starter
 
             pages:

package/users/login-and-logout.yaml

@@ -132,7 +132,7 @@ _ref:
 
             ###### Redirect to the Auth0 logout URL and return to the `logged-out` page in the app after logout:
             ```yaml
-            lowdefy: 3.22.0
+            lowdefy: 3.23.2
             config:
               auth:
                 openId:
@@ -144,7 +144,7 @@ _ref:
 
             ###### Redirect to the Keycloak logout URL and return to the `logged-out` page in the app after logout:
             ```yaml
-            lowdefy: 3.22.0
+            lowdefy: 3.23.2
             config:
               auth:
                 openId:

package/users/openid-connect.yaml

@@ -72,6 +72,7 @@ _ref:
 
             Optional configuration can also be set in the Lowdefy configuration, at the path `config.auth.jwt`. The following fields can be set:
 
+            - `loginStateExpiresIn: string | number`: The length of time an authorization request token should be valid. The default is 5 minutes. If you expect the user will not log-in immediately then you may want to increase this parameter.  Can be expressed as a number in seconds, or a [vercel/ms string](https://github.com/vercel/ms).
             - `expiresIn: string | number`: The length of time a user token should be valid. The default is 4 hours. Can be expressed as a number in seconds, or a [vercel/ms string](https://github.com/vercel/ms).
 
       - _ref:

package/users/protected-pages.yaml

@@ -36,7 +36,7 @@ _ref:
 
             ###### List specific public pages:
             ```yaml
-            lowdefy: 3.22.0
+            lowdefy: 3.23.2
             config:
               auth:
                 pages:
@@ -48,7 +48,7 @@ _ref:
             ````
             ###### List specific protected pages:
             ```yaml
-            lowdefy: 3.22.0
+            lowdefy: 3.23.2
             config:
               auth:
                 pages:

package/users/roles.yaml

@@ -29,7 +29,7 @@ _ref:
             Roles can be read from a custom claim on the OpenID Connect `idToken`. This should be an array of strings which are the role names. This needs to be configured at the OpenID Connect provider. The field that contains the roles array is configured in the `config.auth.openId` field in the Lowdefy configuration.
 
             ```yaml
-            lowdefy: 3.22.0
+            lowdefy: 3.23.2
             config:
               auth:
                 openId:
@@ -43,7 +43,7 @@ _ref:
 
             ###### Protect pages using roles:
             ```yaml
-            lowdefy: 3.22.0
+            lowdefy: 3.23.2
             config:
               auth:
                 openId:

package/users/users-introduction.yaml

@@ -48,7 +48,7 @@ _ref:
           content: |
             Most authorization and authentication settings are configured in the `config.auth` object in the Lowdefy configuration. The following config can be set:
             ```yaml
-            lowdefy: 3.22.0
+            lowdefy: 3.23.2
             config:
               auth:
                 openId:

package/version.yaml

@@ -1 +1 @@
-v3.22.0
+v3.23.2