diff --git a/docgen/docs.yml b/docgen/docs.yml
deleted file mode 100644
index 2f82ec1..0000000
--- a/docgen/docs.yml
+++ /dev/null
@@ -1,172 +0,0 @@
-instances:
- - url: 'https://fileforge.docs.buildwithfern.com'
- custom-domain: 'https://docs.fileforge.com'
-title: Fileforge
-tabs:
- welcome:
- display-name: Welcome
- react-print:
- display-name: react-print
- icon: fa-brands fa-react
- API:
- display-name: API Reference
- icon: fa-solid fa-bolt
- SDK:
- display-name: SDK Reference
- icon: fa-solid fa-code
- help:
- display-name: Help Center
- icon: fa-solid fa-question
-navigation:
- - tab: welcome
- layout:
- - section: Get Started
- contents:
- - page: Welcome
- path: ./pages/overview/introduction.mdx
- slug: welcome
- - tab: react-print
- layout:
- - section: Welcome
- contents:
- - page: Getting Started
- path: ./react-print-pdf/docs/introduction.mdx
- slug: getting-started
- icon: fa-solid fa-hand-wave
- - page: Setup
- path: ./react-print-pdf/docs/getting-started/setup.mdx
- slug: setup
- icon: fa-solid fa-hammer
- - section: Contributing
- contents:
- - page: Contributing
- path: ./react-print-pdf/docs/contributing.mdx
- slug: contributing
- icon: fa-solid fa-code-pull-request
- - section: Components
- contents: []
- - section: Examples
- contents:
- - section: Invoices
- contents:
- - page: Invoice
- path: ./react-print-pdf/docs/ui/templates/invoice.mdx
- slug: invoice
- - page: Invoice Advanced
- path: ./react-print-pdf/docs/ui/templates/invoice-advanced.mdx
- slug: invoice-advanced
- icon: fa-solid fa-file-invoice
- - section: Legal
- contents:
- - page: NDA Markdown
- path: ./react-print-pdf/docs/ui/templates/nda-markdown.mdx
- slug: nda-markdown
- icon: fa-solid fa-file-signature
- - section: Receipts
- contents:
- - page: Receipt
- path: ./react-print-pdf/docs/ui/templates/receipt.mdx
- slug: receipt
- icon: fa-solid fa-receipt
- - section: Reports
- contents:
- - page: Report Charts
- path: ./react-print-pdf/docs/ui/templates/report-charts.mdx
- slug: report-charts
- icon: fa-solid fa-chart-line
- - section: Scientific
- contents:
- - page: Scientific Report
- path: ./react-print-pdf/docs/ui/templates/scientific-report.mdx
- slug: scientific-report
- icon: fa-solid fa-flask
- - tab: API
- layout:
- - section: Introduction
- contents:
- - page: Getting started
- path: ./pages/api-reference/introduction.mdx
- slug: api-reference
- - page: Authentication
- path: ./pages/api-reference/authentication.mdx
- slug: authentication
- - api: API Reference
- snippets:
- typescript: '@fileforge/client'
- - tab: SDK
- layout:
- - section: Getting Started
- contents:
- - page: Getting Started
- path: ./pages/sdk-reference/introduction.mdx
- slug: sdk-reference
- - section: Node
- contents:
- - page: Getting Started
- path: ./pages/sdk-reference/node/introduction.mdx
- slug: node-sdk-reference
- - page: Error Handling
- path: ./pages/sdk-reference/node/errors.mdx
- slug: node-error-handling
- - section: PDF
- contents:
- - page: fromDocx
- path: ./pages/sdk-reference/node/PDF/fromDocx.mdx
- slug: from-docx
- - page: generate
- path: ./pages/sdk-reference/node/PDF/generate.mdx
- slug: generate-from-html
- - page: merge
- path: ./pages/sdk-reference/node/PDF/merge.mdx
- slug: merge
- - section: Form
- contents:
- - page: detect
- path: ./pages/sdk-reference/node/Form/detect.mdx
- slug: detect
- - page: mark
- path: ./pages/sdk-reference/node/Form/mark.mdx
- slug: mark
- - page: fill
- path: ./pages/sdk-reference/node/Form/fill.mdx
- slug: fill
- - section: Types
- contents:
- - page: FormFillRequestOptionsFieldsItem
- path: ./pages/sdk-reference/node/Form/Types/formFillRequestOptionsFieldsItem.mdx
- slug: formFillRequestOptionsFieldsItem
- - page: FormDetectResponseItem
- path: ./pages/sdk-reference/node/Form/Types/FormDetectResponseItem.mdx
- slug: formDetectResponseItem
- - tab: help
- layout:
- - section: HTML to PDF
- contents:
- - page: Generate a PDF with react-print
- path: >-
- ./pages/help_center/html_to_pdf/generate-pdf-from-html-react-print.mdx
- slug: generate-pdf-from-html
- - page: Generate a PDF with assets
- path: ./pages/help_center/html_to_pdf/generate-pdf-from-html-assets.mdx
- slug: generate-pdf-from-html-assets
- - page: Generate a hosted PDF
- path: ./pages/help_center/html_to_pdf/generate-hosted-pdf-from-html.mdx
- slug: generate-hosted-pdf
-colors:
- accentPrimary: '#AD8AFF'
- background:
- dark: '#000000'
- light: '#ffffff'
-logo:
- dark: ./assets/logo-white.svg
- light: ./assets/logo-black.svg
-favicon: ./assets/favicon.png
-layout:
- searchbar-placement: header
-navbar-links:
- - type: minimal
- text: Support
- url: 'mailto:contact@onedoclabs.com'
- - type: outlined
- text: Get Started
- url: 'https://app.onedoclabs.com/login'
diff --git a/docgen/index.ts b/docgen/index.ts
index d52f23c..6dcea0f 100644
--- a/docgen/index.ts
+++ b/docgen/index.ts
@@ -163,6 +163,8 @@ const process = async () => {
return a.name.localeCompare(b.name);
});
+ fs.writeFileSync(path.join(__dirname , "../docs/sortedDocs.json"), JSON.stringify(sortedDocs)); //writes the object for future processing in fileforge-docs
+
sortedDocs.forEach((docFile) => {
docFile.files.forEach((file)=>{
@@ -277,52 +279,7 @@ const process = async () => {
const introductionPath = path.join(__dirname, "../docs/introduction.mdx");
- replaceInFile(introductionPath, "[\s\S]*?<\/Cards>/, snippet); //TODO: fix the relative component import in Fern to avoid this
};
diff --git a/docgen/pageBuilder/buildIntroduction.tsx b/docgen/pageBuilder/buildIntroduction.tsx
index 81d7acd..998de3d 100644
--- a/docgen/pageBuilder/buildIntroduction.tsx
+++ b/docgen/pageBuilder/buildIntroduction.tsx
@@ -2,23 +2,19 @@ import fs from 'fs';
import path from 'path';
-export const replaceInFile = (filePath: string, search: string, replace: string) => {
+export const replaceInFile = (filePath: string, search: RegExp, replace: string) => {
let fileContents = fs.readFileSync(filePath, 'utf8');
- // Find the location to insert at
- const insertLocation = fileContents.indexOf(search);
+ if (search.test(fileContents)) {
+ // Replace the pattern with the new content
+ fileContents = fileContents.replace(search, replace);
- // Check if the location was found
- if (insertLocation !== -1) {
- // Insert the new content
- const newContent = replace;
- fileContents = fileContents.replace(search,newContent);
-
- // Write the file back out
+ // Write the updated content back to the file
fs.writeFileSync(filePath, fileContents);
+ console.log('Replacement successful');
} else {
- console.log('Location not found');
+ console.log('Pattern not found');
}
}
\ No newline at end of file
diff --git a/docs/components/shell/currentpagetop.mdx b/docs/components/shell/currentpagetop.mdx
new file mode 100644
index 0000000..ad500d0
--- /dev/null
+++ b/docs/components/shell/currentpagetop.mdx
@@ -0,0 +1,51 @@
+---
+title: CurrentPageTop
+
+
+---
+
+Displays content in the top of the current page.
+
+This component will override the content of the `PageTop` component for the current page.
+
+Support
+
+
+
+#### Preview
+
+
+
+```jsx
+import { CurrentPageTop } from "@fileforge/react-print";
+
+
+
+```css
+@import url("https://fonts.googleapis.com/css2?family=Inter:wght@400;700&display=swap");
+
+html,
+body {
+ font-size: 28px;
+ font-family: "Inter", sans-serif;
+}
+
+@page {
+ size: A4;
+}
+
+```
+
+
+
+### Examples
+
diff --git a/docs/components/shell/nobreak.mdx b/docs/components/shell/nobreak.mdx
new file mode 100644
index 0000000..f80db0d
--- /dev/null
+++ b/docs/components/shell/nobreak.mdx
@@ -0,0 +1,49 @@
+---
+title: NoBreak
+
+
+---
+
+Prevents a page break. Wrap this component around content that should not be broken across pages.
+
+Support
+
+
+
+#### Preview
+
+
+
+```jsx
+import { NoBreak } from "@fileforge/react-print";
+
+This content will not be split between two pages. ;
+
+```
+
+
+```css
+@import url("https://fonts.googleapis.com/css2?family=Inter:wght@400;700&display=swap");
+
+html,
+body {
+ font-size: 28px;
+ font-family: "Inter", sans-serif;
+}
+
+@page {
+ size: A4;
+}
+
+```
+
+
+
+### Examples
+
diff --git a/docs/components/shell/pagebreak.mdx b/docs/components/shell/pagebreak.mdx
new file mode 100644
index 0000000..f57bd30
--- /dev/null
+++ b/docs/components/shell/pagebreak.mdx
@@ -0,0 +1,53 @@
+---
+title: PageBreak
+
+
+---
+
+Forces a page break.
+
+Support
+
+
+
+#### Preview
+
+
+
+```jsx
+import { PageBreak } from "@fileforge/react-print";
+
+
+
Hello on this page
+
+
World on that page
+
+
+```css
+@import url("https://fonts.googleapis.com/css2?family=Inter:wght@400;700&display=swap");
+
+html,
+body {
+ font-size: 28px;
+ font-family: "Inter", sans-serif;
+}
+
+@page {
+ size: A4;
+}
+
+```
+
+
Display content in other page regions.
+
+ Add signature fields to your document.
A simple, drop-in way to use Tailwind CSS in your components.
Display dynamic values based on your document, such as page numbers and running headers.
-
Help us increase the number of components and start being an active member of
the react-print community by [contributing](/react-print/contributing/contributing)
diff --git a/docs/sortedDocs.json b/docs/sortedDocs.json
new file mode 100644
index 0000000..c946f28
--- /dev/null
+++ b/docs/sortedDocs.json
@@ -0,0 +1 @@
+[{"icon":"fa-solid fa-code","name":"compile","description":"Compile a React component to a string with the Onedoc print styles.","outputPath":"/Users/pierredorge/Documents/onedoc/react-print/docs/components/compile","files":[{"name":"compile","baseName":"compile","path":"compile/compile.tsx","outputPath":"/Users/pierredorge/Documents/onedoc/react-print/docs/components/compile/compile.mdx","markdown":"---\ntitle: compile\n\n\n---\n\nSupport\n\n\n\n#### Preview\n\nA simple function to compile a React component to an HTML string with the Onedoc print styles.\n ```jsx\n const html = await compile(\n\n```jsx\nimport { compile } from \"@fileforge/react-print\";\n\n\n Hello World!
\n ;\n\n```\n \n\n```css\n@import url(\"https://fonts.googleapis.com/css2?family=Inter:wght@400;700&display=swap\");\n\nhtml,\nbody {\n font-size: 28px;\n font-family: \"Inter\", sans-serif;\n}\n\n@page {\n size: A4;\n}\n\n```\n \n \n\n```jsx\nimport { compile } from \"@fileforge/react-print\";\nimport { Button, ChakraProvider, extendTheme } from \"@chakra-ui/react\";\n\n<>\n \n Hello \n \n;\n\n```\n \n\n```css\n@import url(\"https://fonts.googleapis.com/css2?family=Inter:wght@400;700&display=swap\");\n\nhtml,\nbody {\n font-size: 28px;\n font-family: \"Inter\", sans-serif;\n}\n\n@page {\n size: A4;\n}\n\n```\n \n
\n\n","config":{"name":"compile","description":"","components":{"compile":{"server":true,"client":true,"examples":{"default":{"description":"A simple function to compile a React component to an HTML string with the Onedoc print styles.\n ```jsx\n const html = await compile(Hello World!
\n Hello \n \n \n )"}}}}}}]},{"icon":"fa-brands fa-css3-alt","name":"CSS","description":"Allows adding CSS to the document while securely parsing and escaping it.\n\nNB: While you can add regular CSS with the ` 
+
+
+
+
+
+![](\"../../images/previews/compile-2e394416/document.1.jpg\")
\n\n![](\"../../images/previews/compile-1badee62/document.1.jpg\")
\n\n