@lowdefy/docs 4.0.0-alpha.7 → 4.0.0-alpha.8

package/templates/general.yaml.njk

@@ -1,124 +0,0 @@
-# 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: PageSiderMenu
-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 # TODO:
-      params:
-        name: connectDocsearch #}
-    - id: post_telemetry
-      type: Request
-      messages:
-        error: false
-      params: post_telemetry
-
-properties:
-  title: {{ pageTitle }}
-  header:
-    theme: light
-  menu:
-    forceSubMenuRender: true
-  sider:
-    width: 256px
-    initialCollapsed:
-      _or:
-        - _eq:
-            - _media: size
-            - md
-        - _eq:
-            - _media: size
-            - lg
-  layout:
-    style:
-      background: '#FFFFFF'
-  footer:
-    style:
-      background: '#FFFFFF'
-      padding: 16px 0px 0px 0px
-  breadcrumb:
-    list:
-      - _ref: version.yaml
-  {% if section %}
-      - {{ section }}
-      - {{ pageTitle }}
-  {% endif %}
-
-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
-
-  content:
-    justify: center
-    blocks:
-      - id: max_width
-        type: Box
-        layout:
-          flex: 0 1 800px
-        blocks:
-          {% if pageTitle %}
-          - id: page_title
-            type: Title
-            properties:
-              content:
-                _var: pageTitle
-          {% endif %}
-          - id: content
-            type: Box
-            layout:
-              contentGutter: 16
-            blocks:
-              _var: content

package/templates/generateSitemap.js

@@ -1,41 +0,0 @@
-/*
-  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.
-*/
-
-function transformer(pages) {
-  const fs = require('fs');
-  const sitemapStart = `<?xml version="1.0" encoding="UTF-8"?>
-  <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-`;
-  const sitemapEnd = `
-</urlset>`;
-  const now = new Date();
-  const addPage = (acc, page) => {
-    return acc.concat(`
-    <url>
-      <loc>https://docs.lowdefy.com/${page.id}</loc>
-      <lastmod>${now.getFullYear()}-${now.getMonth() > 8 ? '' : 0}${now.getMonth() + 1}-${
-      now.getDate() > 9 ? '' : 0
-    }${now.getDate()}</lastmod>
-    </url>
-`);
-  };
-
-  const sitemap = pages.reduce(addPage, sitemapStart).concat(sitemapEnd);
-
-  fs.writeFileSync('public/sitemap.xml', sitemap);
-  return pages;
-}
-export default transformer;

package/templates/header.yaml

@@ -1,138 +0,0 @@
-# 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: search_box
-  type: Box
-  layout:
-    flex: 0 1 auto
-    align: middle
-  style:
-    marginRight: 8
-  blocks:
-    - id: docsearch
-      type: TextInput
-      layout:
-        flex: 0 1 auto
-        align: middle
-      properties:
-        label:
-          disabled: true
-        placeholder: Search
-    - id: docsearch_icon
-      type: Icon
-      layout:
-        flex: 0 1 auto
-        align: middle
-      style:
-        marginLeft: -22
-      properties:
-        name: AiOutlinedSearch
-- id: why_button
-  type: Button
-  visible:
-    _not:
-      _or:
-        - _eq:
-            - _media: size
-            - md
-        - _eq:
-            - _media: size
-            - sm
-        - _eq:
-            - _media: size
-            - xs
-  layout:
-    flex: 1 0 auto
-  properties:
-    title: Why Lowdefy
-    type: text
-    size: large
-  events:
-    onClick:
-      - id: website_link
-        type: Link
-        params:
-          url: https://lowdefy.com
-- id: tutorial_button
-  type: Button
-  visible:
-    _not:
-      _or:
-        - _eq:
-            - _media: size
-            - md
-        - _eq:
-            - _media: size
-            - sm
-        - _eq:
-            - _media: size
-            - xs
-  layout:
-    flex: 1 0 auto
-  properties:
-    title: Getting Started
-    type: text
-    size: large
-  events:
-    onClick:
-      - id: tutorial_link
-        type: Link
-        params:
-          pageId: tutorial-start
-- id: community_button
-  type: Button
-  visible:
-    _not:
-      _or:
-        - _eq:
-            - _media: size
-            - sm
-        - _eq:
-            - _media: size
-            - xs
-  layout:
-    flex: 1 0 auto
-  properties:
-    title: Join our Discord
-    type: text
-    size: large
-  events:
-    onClick:
-      - id: website_link
-        type: Link
-        params:
-          url: https://discord.gg/WmcJgXt
-- id: github_button
-  type: Button
-  visible:
-    _not:
-      _or:
-        - _eq:
-            - _media: size
-            - sm
-        - _eq:
-            - _media: size
-            - xs
-  layout:
-    flex: 1 0 auto
-  properties:
-    title: Star on Github
-    type: text
-    icon: AiFilledGithub
-    size: large
-  events:
-    onClick:
-      - id: website_link
-        type: Link
-        params:
-          url: https://github.com/lowdefy/lowdefy

package/templates/navigation_buttons.yaml

@@ -1,68 +0,0 @@
-# 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: nav_buttons
-type: Box
-style:
-  marginTop: 40px
-  marginBottom: 80px
-layout:
-  contentGutter: 16
-blocks:
-  - id: previous_button
-    type: Button
-    layout:
-      span: 12
-    properties:
-      block: true
-      hideActionLoading: true
-      icon: AiOutlinedArrowLeft
-      size: large
-      title:
-        _var: previous_page_title
-      type: default
-    events:
-      onClick:
-        - id: link_back
-          type: Link
-          params:
-            pageId:
-              _var: previous_page_id
-        - id: scroll_to_top
-          type: ScrollTo
-          params:
-            top: 0
-  - id: next_button
-    type: Button
-    layout:
-      span: 12
-    properties:
-      block: true
-      hideActionLoading: true
-      icon: AiOutlinedArrowRight
-      size: large
-      title:
-        _var: next_page_title
-      type: default
-    events:
-      onClick:
-        - id: link_forward
-          type: Link
-          params:
-            pageId:
-              _var: next_page_id
-        - id: scroll_to_top
-          type: ScrollTo
-          params:
-            top: 0

package/templates/operators.yaml.njk

@@ -1,82 +0,0 @@
-# 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.
-methods:
-  _var: methods
-page:
-  _ref:
-    path: templates/general.yaml.njk
-    vars:
-      pageId:
-        _var: pageId
-      pageTitle:
-        _var: pageTitle
-      section: Operators
-      content:
-        - id: warning
-          type: Alert
-          visible:
-            _not: 
-              _not:
-                _var: warning
-          properties:
-            message: 
-              _var: warning
-            type: warning
-        - id: environment
-          type: Alert
-          visible:
-            _not: 
-              _not:
-                _var: env
-          properties:
-            message: 
-              _string.concat:
-                - 'Environment: '
-                - _var: env
-            type: info
-        - id: types
-          type: Markdown
-          style:
-            '.markdown-body':
-              fontSize: 14px
-          properties:
-            content:
-              _var: types
-        - id: description
-          type: MarkdownWithCode
-          properties:
-            content:
-              _var: description
-        {% if arguments %}
-        - id: arguments_title
-          type: Markdown
-          properties:
-            content: '#### Arguments'
-        - id: arguments
-          type: MarkdownWithCode
-          properties:
-            content:
-              _var: arguments
-        {% endif %}
-        {% if examples %}
-        - id: examples_title
-          type: Markdown
-          properties:
-            content: '#### Examples'
-        - id: examples
-          type: MarkdownWithCode
-          properties:
-            content:
-              _var: examples
-        {% endif %}

package/templates/operatorsMethodTransformer.js

@@ -1,119 +0,0 @@
-/*
-  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.
-*/
-
-function transformer(obj) {
-  // console.log(JSON.stringify(obj, null, 2));
-  if (!obj.methods) {
-    return obj.page;
-  }
-  const contentArray = obj.page.areas.content.blocks[0].blocks[1].blocks;
-  const operatorName = obj.page.properties.title;
-
-  contentArray.push({
-    id: `methods_title`,
-    type: 'Markdown',
-    properties: {
-      content: '# Operator methods:',
-    },
-  });
-
-  obj.methods.forEach((method) => {
-    // console.log(method);
-    contentArray.push({
-      id: `${method.name}_link`,
-      type: 'Anchor',
-      properties: {
-        title: `${operatorName}.${method.name}`,
-        icon: 'AiOutlinedLink',
-      },
-      events: {
-        onClick: [
-          {
-            id: 'scroll',
-            type: 'ScrollTo',
-            params: {
-              blockId: `${method.name}_title`,
-            },
-          },
-        ],
-      },
-    });
-  });
-
-  // const methodsBlocks = [];
-  obj.methods.forEach((method) => {
-    // console.log(method);
-    contentArray.push({
-      id: `${method.name}_title`,
-      type: 'Markdown',
-      properties: {
-        content: `## ${operatorName}.${method.name}`,
-      },
-    });
-    contentArray.push({
-      id: `${method.name}_types`,
-      type: 'Markdown',
-      style: {
-        '.markdown-body': { fontSize: '14px' },
-      },
-      properties: {
-        content: method.types,
-      },
-    });
-    contentArray.push({
-      id: `${method.name}_description`,
-      type: 'MarkdownWithCode',
-      properties: {
-        content: method.description,
-      },
-    });
-    if (method.arguments) {
-      contentArray.push({
-        id: `${method.name}_arguments_title`,
-        type: 'Markdown',
-        properties: {
-          content: '#### Arguments',
-        },
-      });
-      contentArray.push({
-        id: `${method.name}_arguments`,
-        type: 'MarkdownWithCode',
-        properties: {
-          content: method.arguments,
-        },
-      });
-    }
-    if (method.examples) {
-      contentArray.push({
-        id: `${method.name}_arguments_title`,
-        type: 'Markdown',
-        properties: {
-          content: '#### Examples',
-        },
-      });
-      contentArray.push({
-        id: `${method.name}_examples`,
-        type: 'MarkdownWithCode',
-        properties: {
-          content: method.examples,
-        },
-      });
-    }
-  });
-  return obj.page;
-}
-
-export default transformer;