diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..c211500 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright 2024 CodeMuse, Inc + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 708d58b..dfab0bf 100644 --- a/README.md +++ b/README.md @@ -14,31 +14,36 @@ --- +# Introduction + +A collection of high-quality, unstyled components for creating beautiful PDFs using React and TypeScript. Forget about docx, latex, or painful outdates libraries. With react-print, embrace a new way you create PDFs, designed by and for developers. + +# Why + +At [Onedoc](https://www.onedoclabs.com/), we believe documents are the core of communication. Invoice, contracts, resume, bill, etc. Documents are the #1 way to exchange information with others in a professional way, so why are we still using decades old technology to create them ? We believe that you deserve better. Document production needs to be modernized. Start today and create your next PDF the same way you build a webapp. And yes, it includes automation of data integration into your documents. + # Getting started ## 1. Installation Get the react-print component library. - - +### With npm ```sh npm npm install -s @onedoc/react-print ``` - +### With yarn ```sh yarn yarn add @onedoc/react-print ``` - +### With pnpm ```sh pnpm pnpm add @onedoc/react-print ``` - - ## 2. Import component -Import a component as follow: +Import the components you need to your PDF template from our list of pre-build components : ```javascript import { PageTop, PageBottom, PageBreak } from '@onedoc/react-print'; @@ -46,26 +51,61 @@ import { PageTop, PageBottom, PageBreak } from '@onedoc/react-print'; ## 3. Integrate in your document: +Integrate your components and include styles where needed. ```javascript export const document = ({props}) => { return ( +
+ + Hello #1 +
- - Hello #1 - -
- Hello #2 -
- -
- Hello #3 -
- - - Hello #4, but on a new page ! + Hello #2
- ); + +
+ Hello #3 +
+ + + Hello #4, but on a new page ! +
+ ); }; ``` + +# Components +A set of standard components to help you build amazing documents without having to deal with the mess of creating complex layouts and maintaining archaic markup. Help us increasing the length of this list by contributing actively and adding your favorite components ! + +* [Footnote](https://github.com/OnedocLabs/react-print/tree/main/src/Footnote) +* [Shell](https://github.com/OnedocLabs/react-print/tree/main/src/Shell) +* [Running Header](https://github.com/OnedocLabs/react-print/tree/main/src/RunningHeader) + +# Integrations + +PDFs generated by *React Print* can be hosted (and more) on your favorite document management providers. + +* [Onedoc](https://app.onedoclabs.com/login) **(our preferred system, designed by and for developers)** +* Google Drive *(coming soon..)* +* Microsoft SharePoint *(coming soon..)* + +# Contributing + +This project is open-source and is meant to be maintained and build by and for the developers.
+ +Wanna help ? Awesome! There are many ways you can contribute ! Take a look at: + +* (Contributing Guide)[www.google.com] + +# Authors + +* Auguste L. ([@thisisnotFranck](https://twitter.com/thisisnotfranck)) +* Pierre D. ([@pierre_dge120](https://twitter.com/pedro_dge120)) +* Titouan L. ([@titouan325](https://twitter.com/titouan325)) + +# License + +[MIT License]() + --- diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index c89c478..0000000 --- a/docs/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# Mintlify Starter Kit - -Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including - -- Guide pages -- Navigation -- Customizations -- API Reference pages -- Use of popular components - -### Development - -Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command - -``` -npm i -g mintlify -``` - -Run the following command at the root of your documentation (where mint.json is) - -``` -mintlify dev -``` - -### Publishing Changes - -Install our Github App to autopropagate changes from youre repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. - -#### Troubleshooting - -- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. -- Page loads as a 404 - Make sure you are running in a folder with `mint.json`