feat: add macros plugin (#703)

* feat: add macros plugin

* feat: switch to mkdocs-git-revision-date-localized-plugin for compatibility with macros plugin

* update insiders yaml

* add macros plugin to insiders

* fix: white space in insiders.mkdocs.yml

* chore: add macros to eslint ignore (same as includes)

* chore: fix typos in macros

---------

Co-authored-by: Brian Giori <[email protected]>

Author: justin-fiedler

.markdownlintignore

@@ -1,4 +1,5 @@
 /includes
+/macros
 LICENSE.md
 /vale
-/.github
+/.github

cspellignore.txt

@@ -95,6 +95,7 @@ DSAR
 EBRs
 Eckert
 elif
+endmacro
 encid
 Enterpret
 enterpret

insiders.mkdocs.yml

@@ -6,7 +6,13 @@ extra_css:
 plugins:
   - search
   - tags #insiders
-  - git-revision-date
+  - git-revision-date-localized
+  - macros:
+      include_dir: macros
+      j2_block_start_string: '@{%'
+      j2_block_end_string: '%}'
+      j2_variable_start_string: '@{{'
+      j2_variable_end_string: '}}'
   - glightbox # enables image light box
   - social: #insiders
       cards_color:
@@ -59,7 +65,7 @@ markdown_extensions:
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
   - pymdownx.tabbed: # Enables content tabs
-      alternate_style: true 
+      alternate_style: true
       slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
           case: lower
@@ -69,8 +75,8 @@ markdown_extensions:
 
 
 
-# Long explanation for this extra doc. 
+# Long explanation for this extra doc.
 # In order to use config inheritance, everything must use the alternative syntax (key:value vs lists)
-# Lists are replaced wholesale with config inheritence. 
+# Lists are replaced wholesale with config inheritence.
 # I couldn't get alternative syntax to work on mkdocs.yml without throwing constant errors and strange behavior.
-# For now, mkdocs.yml plugins need to be all NON-insiders plugins, and insiders.mkdocs.yml is ALL plugins. 
+# For now, mkdocs.yml plugins need to be all NON-insiders plugins, and insiders.mkdocs.yml is ALL plugins.

macros/macros.md

@@ -0,0 +1,4 @@
+@{% macro input(name, value='', type='text', size=20) -%}
+<input type="@{{ type }}" name="@{{ name }}" value="@{{
+value|e }}" size="@{{ size }}">
+@{%- endmacro %}

macros/sdk-configuration-ts.md

@@ -0,0 +1,19 @@
+@{% macro sdk_configuration_ts(flushIntervalSeconds=1, flushQueueSize=30, flushMaxRetries=5) -%}
+???config "Configuration Options"
+    | <div class="big-column">Name</div>  | Description | Default Value |
+    | --- | --- | --- |
+    |`apiKey`| Required. `string`. The apiKey of your project. | `null` | 
+    |`flushIntervalMillis`| `number`. The amount of time waiting to upload the event to the server in milliseconds. | @{{flushIntervalSeconds}} second@{% if flushIntervalSeconds > 1 %}s@{% endif %}.|
+    |`flushQueueSize`| `number`. The maximum number of events that can be stored locally before forcing an upload.  | @{{flushQueueSize}} events. |
+    |`flushMaxRetries`| `number`. The max retry limits. | @{{flushMaxRetries}} times.|
+    |`logLevel`| `LogLevel.None` or `LogLevel.Error` or `LogLevel.Warn` or `LogLevel.Verbose` or `LogLevel.Debug`. The log level. | `LogLevel.Warn` |
+    |`loggerProvider`| `Logger`. Implements a custom `loggerProvider` class from the Logger, and pass it in the configuration during the initialization to help with collecting any error messages from the SDK in a production environment.| `Amplitude Logger` |
+    |`minIdLength`| `number`. Overrides the minimum length of `user_id` & `device_id` fields. | `5` |
+    |`optOut`| `boolean`. If `optOut` is `true`, the event isn't sent to Amplitude's servers. | `false` |
+    |`serverUrl`| `string`. The server url events upload to. | `https://api2.amplitude.com/2/httpapi` | 
+    |`serverZone`| `EU` or  `US`. Set Amplitude Server Zone, switch to zone related configuration. To send data to Amplitude's EU servers should configure to `EU` | `US` |
+    |`storageProvider`| `Storage<Event[]>`. Implements a custom `storageProvider` class from Storage. | `MemoryStorage` |
+    |`useBatch`| `boolean`. When `true`, uses the Batch API instead of the HTTP V2 API.| `false` |
+    |`transportProvider`| `Transport`. Custom HTTP client. For example, sending requests to your proxy server with customized HTTP request headers.| `Transport` |
+    |`transport`| `TransportType.XHR` or `TransportType.SendBeacon` or `TransportType.Fetch`. Set the transport type. | `TransportType.Fetch` |
+@{%- endmacro %}

mkdocs.yml

@@ -67,7 +67,13 @@ extra_javascript:
 # When you add a plugin here, make sure the change is updated in insiders.mkdocs.yml and insiders.local.build.yml too.
 plugins:
   - search # the search plugin
-  - git-revision-date # enables the git revision date functionality
+  - git-revision-date-localized # enables the git revision date functionality, compatible with macros plugin
+  - macros:
+      include_dir: macros
+      j2_block_start_string: '@{%'
+      j2_block_end_string: '%}'
+      j2_variable_start_string: '@{{'
+      j2_variable_end_string: '}}'
 
 # Extensions
 # When you add or change an extension here, mirror changes in insiders.mkdocs.yml.

requirements.txt

@@ -18,7 +18,8 @@ mkdocs-glightbox==0.2.1
 pygments-graphql-lexer==0.1.0
 
 # Requirements for plugins
-mkdocs-git-revision-date-plugin==0.3.1
+mkdocs-git-revision-date-localized-plugin==1.2.0
+mkdocs-macros-plugin==0.7.0
 babel>=2.10.3
 lxml>=4.6
 paginate>=0.5.6