Merge pull request #67 from intelops/main

sync main into chandu branch

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "overrides": [
+    {
+      "files": ["*.html"],
+      "options": {
+        "parser": "go-template",
+        "goTemplateBracketSpacing": true,
+        "bracketSameLine": true
+      }
+    }
+  ]
+}

config.toml

@@ -14,6 +14,9 @@ enableGitInfo = true
 [outputFormats.JSON]
 isPlainText = false
 
+[minify]
+  disableHTML = true
+
 [outputs]
 home = ["HTML","JSON"]
 
@@ -190,19 +193,37 @@ weight = 3
 
 # CSS Plugin
 [[params.plugins.css]]
-link = "plugins/bootstrap/bootstrap.min.css"
-[[params.plugins.css]]
 link = "plugins/featherlight/featherlight.min.css"
+[[params.plugins.css]]
+link = "plugins/font-awesome/solid.css"
+[[params.plugins.css]]
+link = "plugins/font-awesome/regular.css"
+[[params.plugins.css]]
+link = "plugins/font-awesome/brands.css"
+[[params.plugins.css]]
+link = "plugins/font-awesome/icons.css"
 
 
 # JS Plugin
 [[params.plugins.js]]
 link = "plugins/jquery/jquery.min.js"
 [[params.plugins.js]]
 link = "plugins/bootstrap/bootstrap.min.js"
+# [[params.plugins.js]]
+# link = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/js/all.min.js"
+# attributes = "crossorigin='anonymous' defer='defer' data-search-pseudo-elements"
+[[params.plugins.js]]
+link = "plugins/search/auto-complete.js"
+[[params.plugins.js]]
+link = "plugins/search/search.js"
+[[params.plugins.js]]
+link = "plugins/search/lunr.min.js"
+[[params.plugins.js]]
+link = "plugins/search/fuse.min.js"
+[[params.plugins.js]]
+link = "plugins/search/mark.js"
 [[params.plugins.js]]
-link = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.2/js/all.min.js"
-attributes = "crossorigin='anonymous' defer='defer' data-search-pseudo-elements"
+link = "plugins/search/search-page.js"
 [[params.plugins.js]]
 link = "plugins/masonry/masonry.min.js"
 [[params.plugins.js]]

content/1.0.1/compage/1-docs-structure/_index.en.md

@@ -5,25 +5,22 @@ weight: 1
 draft: false
 ---
 
-
 ![Compage-banner](compage_logo.svg#gh-light-mode-only)
 
-<!-- hidding this twitter for now since twitter account is having issues. 
+<!-- hidding this twitter for now since twitter account is having issues.
 
 [![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social&label=Follow%20%40IntelOpsAi)](https://twitter.com/IntelOpsAi) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Draw%20and%20Generate%20Code&url=https://github.com/intelops/compage&via=IntelOpsAi&hashtags=compage,codegeneration,cloud,devops)
 
 -->
 
-
 This section is a high-level overview of how the Compage Documentation is structured. It will help you use the documentation more effectively by guiding you on where to look for specific information.
 
 The Compage Documentation covers everything you need to know about Compage. It made up of four main sections which are:
 
 - [Getting started](../3-installation)
 - [Contributing](../6-contribution)
 - [User Guide](../5-guides)
-- [FAQs](../8-faq) 
-
+- [FAQs](../8-faq)
 
 ## Introduction
 
@@ -34,7 +31,6 @@ The `What is Compage?` page summarizes the goals and features of the Compage pro
 - [Community](../4-community)
 - [Installation](../3-installation)
 
-
 ## Contributing
 
 Compage is written in `Golang`, `NodeJS` and `ReactJS` and is `Apache License` - contributions are always welcome whether that means providing feedback, be it through GitHub, through the `#feedback` channel on our [Discord server](https://discord.gg/DeapQc22qe) or testing existing and new features. All the relevant information below:
@@ -51,4 +47,4 @@ We want to be able to give Compage users the tips and guidance necessary to be a
 
 Find all the answers to all the Compage related questions you might have. Feel free to reach out via the `#feedback` channel on [Discord](https://discord.gg/DeapQc22qe) to request the inclusion of additional questions.
 
-- [FAQs](../8-faq)
+- [FAQs](../8-faq)

content/1.0.1/compage/2-overview/_index.en.md

@@ -5,7 +5,6 @@ weight: 2
 draft: false
 ---
 
-
 ![Compage-banner](compage_logo.svg#gh-light-mode-only)
 
 **Compage** is the `open-source` project by IntelOps.
@@ -26,6 +25,7 @@ cloud-events, vulnerability reports, etc. auto generate code after defining requ
 diagram.
 
 **Draw the requirements for backend workloads, and then auto generate code, customize it and maintain it by using Compage.**
+
 > Our goal is to support both auto-generate code and import existing code. Let's see how far we can go with importing
 > existing code support. One step at a time!
 
@@ -85,7 +85,7 @@ Problems with many of the current low-code platforms -
   and integrations, and also git repo observability.**
 - **Please suggest what you would like to add as features.**
 
--------------------------
+---
 
 ### Current features in compage
 
@@ -147,21 +147,21 @@ file is updated in GitHub repository with the latest state of canvas.
 Compage has 3 components: core, app and ui.
 
 - core
-    - This is a `Go` component and acts as code generator for the configurations passed.
-    - This component considers the configuration passed from `app` and runs it on the templates.
-    - This component is a gRPC server to `app` component and streams the generated code back to `app`.
-    - Currently, it supports REST protocol and two types of REST templates are supported as of now.
-        1. Compage managed templates
-           The Compage managed templates are git submodules in the `core` component. If you want to support more
-           frameworks or languages, you have to add the template in a separate repository and import it as submodule in
-           this project. The current template for `Go` is a separate
-           repository - https://github.com/intelops/compage-template-go.git
-        2. OpenApi Generator templates
+  - This is a `Go` component and acts as code generator for the configurations passed.
+  - This component considers the configuration passed from `app` and runs it on the templates.
+  - This component is a gRPC server to `app` component and streams the generated code back to `app`.
+  - Currently, it supports REST protocol and two types of REST templates are supported as of now.
+    1. Compage managed templates
+       The Compage managed templates are git submodules in the `core` component. If you want to support more
+       frameworks or languages, you have to add the template in a separate repository and import it as submodule in
+       this project. The current template for `Go` is a separate
+       repository - https://github.com/intelops/compage-template-go.git
+    2. OpenApi Generator templates
 - app
-    - This is a `NodeJs` component and is responsible for authentication with GitHub and all the GitHub related
-      operations.
-    - This component is a REST server to `ui` component and also a gRPC client to `core`.
-    - Further additions of other logins and GitHub operations will be done in this component.
+  - This is a `NodeJs` component and is responsible for authentication with GitHub and all the GitHub related
+    operations.
+  - This component is a REST server to `ui` component and also a gRPC client to `core`.
+  - Further additions of other logins and GitHub operations will be done in this component.
 - ui
-    - This is a `ReactJs` component and has an integration with aws diagram-maker for canvas.
-    - User draws diagram and the json created out of it is used to generate the code.
+  - This is a `ReactJs` component and has an integration with aws diagram-maker for canvas.
+  - User draws diagram and the json created out of it is used to generate the code.