feature: css + js + measure img size (#2872)

* new configs * config * naming * updates * font settings * remove v1 * implement converters to typographyV2 and layout * thread implementation * upgrade fern-docs config * fix docsconfigfile visitor * reset settings * fix error * update snap * fix colors and layout * private * add support for stream * css and js options * add measurement * fix dependencies * sharp * remove plaiceholder for now * fix js * fix js * wire up strat * resolve path for css * fixg * fix yarn * fix snap --------- Co-authored-by: dsinghvi <[email protected]>
fern-api · Feb 11, 2024 · b4748c8 · b4748c8
1 parent ec9d6f7
commit b4748c8
Show file tree

Hide file tree

Showing 24 changed files with 461 additions and 89 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/...nfig-npm-0.0.70-89a0ccbe9f-39a0a8e8a5.zip → ...nfig-npm-0.0.75-91c3b78e3e-3629548884.zip b/...nfig-npm-0.0.70-89a0ccbe9f-39a0a8e8a5.zip → ...nfig-npm-0.0.75-91c3b78e3e-3629548884.zip
diff --git a/.yarn/cache/esbuild-darwin-64-npm-0.15.7-723c8cbc8e-8.zip b/.yarn/cache/esbuild-darwin-64-npm-0.15.7-723c8cbc8e-8.zip
diff --git a/.yarn/cache/esbuild-linux-32-npm-0.15.7-66ab0695a4-8.zip b/.yarn/cache/esbuild-linux-32-npm-0.15.7-66ab0695a4-8.zip
diff --git a/.yarn/cache/esbuild-linux-arm64-npm-0.15.7-e6e6e4f6e0-8.zip b/.yarn/cache/esbuild-linux-arm64-npm-0.15.7-e6e6e4f6e0-8.zip
diff --git a/.yarn/cache/esbuild-windows-32-npm-0.15.7-fc771388e0-8.zip b/.yarn/cache/esbuild-windows-32-npm-0.15.7-fc771388e0-8.zip
diff --git a/.yarn/cache/esbuild-windows-64-npm-0.15.7-005954b31a-8.zip b/.yarn/cache/esbuild-windows-64-npm-0.15.7-005954b31a-8.zip
diff --git a/.yarn/cache/esbuild-windows-arm64-npm-0.15.7-0f216ed1a9-8.zip b/.yarn/cache/esbuild-windows-arm64-npm-0.15.7-0f216ed1a9-8.zip
diff --git a/.yarn/cache/image-size-npm-1.1.1-4e6d664667-23b3a515dd.zip b/.yarn/cache/image-size-npm-1.1.1-4e6d664667-23b3a515dd.zip
diff --git a/.yarn/cache/queue-npm-6.0.2-ebbcf599cf-ebc2363924.zip b/.yarn/cache/queue-npm-6.0.2-ebbcf599cf-ebc2363924.zip
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -45,3 +45,15 @@ plugins:
     spec: "@yarnpkg/plugin-workspace-tools"
 
 yarnPath: .yarn/releases/yarn-3.6.1.cjs
+
+supportedArchitectures:
+  os:
+    - current
+    - darwin
+    - linux
+    - win32
+  cpu:
+    - current
+    - x64
+    - ia32
+    - arm64
diff --git a/fern/apis/docs-config/definition/docs.yml b/fern/apis/docs-config/definition/docs.yml
@@ -24,6 +24,8 @@ types:
       layout:
         type: optional<LayoutConfig>
         availability: in-development
+      css: optional<CssConfig>
+      js: optional<JsConfig>
 
   TabId: string
 
@@ -338,3 +340,89 @@ types:
     properties:
       url: string
       text: string
+
+  CssConfig:
+    docs: |-
+      The `css` object allows you to customize the appearance of your docs site by injecting custom CSS, i.e.
+
+      ```yaml
+      css: "path/to/css/file.css"
+      ```
+
+      or, multiple files:
+
+      ```yaml
+      css:
+        - "path/to/css/file.css"
+        - "path/to/another/css/file.css"
+      ```
+    discriminated: false
+    union:
+      - string # path to css file
+      - list<string>
+
+  JsConfig:
+    docs: |-
+      The `js` object allows you to customize the behavior of your docs site by injecting custom JavaScript, i.e.
+
+      ```yaml
+      js: "path/to/js/file.js"
+      ```
+
+      or, multiple files:
+
+      ```yaml
+      js:
+        - "path/to/js/file.js"
+        - "path/to/another/js/file.js"
+      ```
+
+      or remote js:
+
+      ```yaml
+      js:
+        url: "https://example.com/path/to/js/file.js"
+        strategy: "afterInteractive"
+      ```
+
+      or, mixed:
+
+      ```yaml
+      js:
+        - "path/to/js/file.js"
+        - path: "path/to/another/js/file.js"
+          strategy: "beforeInteractive"
+        - url: "https://example.com/path/to/js/file.js"
+      ```
+    discriminated: false
+    union:
+      - JsConfigOptions
+      - list<JsConfigOptions>
+
+  JsConfigOptions:
+    discriminated: false
+    union:
+      - JsRemoteConfig
+      - JsFileConfig
+
+  JsRemoteConfig:
+    properties:
+      url: string
+      strategy: optional<JsScriptStrategy>
+
+  JsFileConfig:
+    discriminated: false
+    union:
+      - string # path to js file
+      - JsFileConfigSettings
+
+  JsFileConfigSettings:
+    properties:
+      path: string
+      strategy: optional<JsScriptStrategy>
+
+  JsScriptStrategy:
+    enum:
+      - beforeInteractive
+      - afterInteractive # default
+      - lazyOnload
diff --git a/fern/docs.yml b/fern/docs.yml
@@ -1,6 +1,7 @@
 instances:
-  - url: fern.docs.buildwithfern.com
-    custom-domain: docs.buildwithfern.com
+  # - url: fern.docs.buildwithfern.com
+  #   custom-domain: docs.buildwithfern.com
+  - url: fern.docs.dev.buildwithfern.com
 
 title: Fern | Documentation
 

diff --git a/packages/cli/config-management/docs-configuration/package.json b/packages/cli/config-management/docs-configuration/package.json
@@ -32,7 +32,7 @@
     "@fern-api/fdr-sdk": "0.46.1-19-g5e3bf66",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/task-context": "workspace:*",
-    "@fern-fern/docs-config": "0.0.70",
+    "@fern-fern/docs-config": "0.0.75",
     "js-yaml": "^4.1.0",
     "tinycolor2": "^1.6.0"
   },

diff --git a/packages/cli/config-management/docs-configuration/src/ParsedDocsConfiguration.ts b/packages/cli/config-management/docs-configuration/src/ParsedDocsConfiguration.ts
@@ -22,6 +22,18 @@ export interface ParsedDocsConfiguration {
     layout: WithoutQuestionMarks<DocsV1Write.DocsLayoutConfig> | undefined;
     /* filepath of page to contents */
     pages: Record<RelativeFilePath, string>;
+    css: DocsV1Write.CssConfig | undefined;
+    js: JavascriptConfig | undefined;
+}
+
+export interface AbsoluteJsFileConfig {
+    absolutePath: AbsoluteFilePath;
+    strategy?: DocsV1Write.JsScriptStrategy;
+}
+
+export interface JavascriptConfig {
+    remote?: DocsV1Write.JsRemoteConfig[];
+    files: AbsoluteJsFileConfig[];
 }
 
 export interface DocsColorsConfiguration {