From f8798659888574c107b5510461d9243bbb6bea6d Mon Sep 17 00:00:00 2001 From: Johnathan Fercher Date: Thu, 28 Sep 2023 12:25:36 -0300 Subject: [PATCH] Update docs --- docs/README.md | 2 +- docs/_sidebar.md | 36 +++--------------------------------- docs/v2/basics.md | 27 --------------------------- docs/v2/configbuilder.md | 11 ----------- docs/v2/examples/_sidebar.md | 3 +++ docs/v2/features/_sidebar.md | 28 ++++++++++++++++++++++++++++ 6 files changed, 35 insertions(+), 72 deletions(-) delete mode 100644 docs/v2/basics.md delete mode 100644 docs/v2/configbuilder.md create mode 100644 docs/v2/examples/_sidebar.md create mode 100644 docs/v2/features/_sidebar.md diff --git a/docs/README.md b/docs/README.md index afe4af50..45ebc860 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# Maroto +# Maroto V2 [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go#template-engines) [![Branch](https://img.shields.io/badge/V2-Branch-pink)](https://github.com/johnfercher/maroto/tree/v2) [![Roadmap](https://img.shields.io/badge/V2-Roadmap-purple)](https://github.com/users/johnfercher/projects/1) [![Discussion](https://img.shields.io/badge/V2-Discussion-blue)](https://github.com/johnfercher/maroto/issues/257) [![Release Notes](https://img.shields.io/badge/Release-Notes-cyan)](https://github.com/johnfercher/maroto/releases) [![Visits Badge](https://badges.pufler.dev/visits/johnfercher/maroto)](https://badges.pufler.dev) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 96a947d3..2e329ccf 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,35 +1,5 @@ -* [Maroto V2](README.md?id=home) - * **Documentation** - * [Basics](v2/basics.md?id=generating-pdf) - * [Config Builder](v2/configbuilder.md?id=config-builder) - * **Features** - * [Add Page](v2/features/addpage.md?id=add-page) - * [Add PDF](v2/features/addpdf.md?id=add-pdf) - * [Barcode](v2/features/barcode.md?id=barcode) - * [Cell Style](v2/features/cellstyle.md?id=cell-style) - * [Compression](v2/features/compression.md?id=compression) - * [Custom Dimensions](v2/features/customdimensions.md?id=custom-dimensions) - * [Custom Font](v2/features/customfont.md?id=custom-font) - * [Custom Page](v2/features/custompage.md?id=custom-page) - * [Data Matrix](v2/features/datamatrix.md?id=data-matrix) - * [Footer](v2/features/footer.md?id=footer) - * [Header](v2/features/header.md?id=header) - * [Images](v2/features/image.md?id=image) - * [Line](v2/features/line.md?id=line) - * [List](v2/features/list.md?id=list) - * [Margins](v2/features/margins.md?id=custom-margins) - * [Max Grid Sum](v2/features/maxgridsum.md?id=max-grid-sum) - * [Metadatas](v2/features/metadatas.md?id=metadatas) - * [Orientation](v2/features/orientation.md?id=orientation) - * [Page Number](v2/features/pagenumber.md?id=page-number) - * [Parallelism](v2/features/parallelism.md?id=parallelism) - * [PDF 2 ZPL](v2/features/pdf2zpl?id=pdf-2-zpl) - * [Protection](v2/features/protection.md?id=protection) - * [QR Code](v2/features/qrcode.md?id=qrcode) - * [Signature](v2/features/signature.md?id=signature) - * [Text](v2/features/text.md?id=text) - * [Unit Testing](v2/features/unittests.md?id=unit-testing) - * **Examples** - * [Billing](v2/examples/billing.md?id=billing) +* [Maroto V2](README.md?id=maroto-v2) + * [Features](v2/features/addpage.md?id=add-page) + * [Examples](v2/examples/billing.md?id=billing) * [Maroto V1 (Deprecated)](v1/README.md?id=deprecated) * [Documentation](v1/documentation.md?id=documentation) diff --git a/docs/v2/basics.md b/docs/v2/basics.md deleted file mode 100644 index 3297d621..00000000 --- a/docs/v2/basics.md +++ /dev/null @@ -1,27 +0,0 @@ -# Generating PDF - -**Code** - -[filename](../assets/go/basics/save/main.go ':include :type=code') - -## Retrieving Bytes - -**Code** - -[filename](../assets/go/basics/bytes/main.go ':include :type=code') - -## Retrieving Base64 - -**Code** - -[filename](../assets/go/basics/base64/main.go ':include :type=code') - -## Using Metrics Decorator - -**Code** - -[filename](../assets/go/basics/metrics/main.go ':include :type=code') - -**Response** - -[filename](../assets/text/report.txt ':include :type=code') \ No newline at end of file diff --git a/docs/v2/configbuilder.md b/docs/v2/configbuilder.md deleted file mode 100644 index 23d1d649..00000000 --- a/docs/v2/configbuilder.md +++ /dev/null @@ -1,11 +0,0 @@ -# Config Builder - -## Debug -**Code** - -[filename](../assets/go/config/debug/main.go ':include :type=code') - -## Page Size -**Code** - -[filename](../assets/go/config/pagesize/main.go ':include :type=code') diff --git a/docs/v2/examples/_sidebar.md b/docs/v2/examples/_sidebar.md new file mode 100644 index 00000000..982ba077 --- /dev/null +++ b/docs/v2/examples/_sidebar.md @@ -0,0 +1,3 @@ +* [← Back To Home](README.md?id=maroto-v2) +* **Examples** + * [Billing](v2/examples/billing.md?id=billing) diff --git a/docs/v2/features/_sidebar.md b/docs/v2/features/_sidebar.md new file mode 100644 index 00000000..1df6a175 --- /dev/null +++ b/docs/v2/features/_sidebar.md @@ -0,0 +1,28 @@ +* [← Back To Home](README.md?id=maroto-v2) +* **Features** + * [Add Page](v2/features/addpage.md?id=add-page) + * [Add PDF](v2/features/addpdf.md?id=add-pdf) + * [Barcode](v2/features/barcode.md?id=barcode) + * [Cell Style](v2/features/cellstyle.md?id=cell-style) + * [Compression](v2/features/compression.md?id=compression) + * [Custom Dimensions](v2/features/customdimensions.md?id=custom-dimensions) + * [Custom Font](v2/features/customfont.md?id=custom-font) + * [Custom Page](v2/features/custompage.md?id=custom-page) + * [Data Matrix](v2/features/datamatrix.md?id=data-matrix) + * [Footer](v2/features/footer.md?id=footer) + * [Header](v2/features/header.md?id=header) + * [Images](v2/features/image.md?id=image) + * [Line](v2/features/line.md?id=line) + * [List](v2/features/list.md?id=list) + * [Margins](v2/features/margins.md?id=custom-margins) + * [Max Grid Sum](v2/features/maxgridsum.md?id=max-grid-sum) + * [Metadatas](v2/features/metadatas.md?id=metadatas) + * [Orientation](v2/features/orientation.md?id=orientation) + * [Page Number](v2/features/pagenumber.md?id=page-number) + * [Parallelism](v2/features/parallelism.md?id=parallelism) + * [PDF 2 ZPL](v2/features/pdf2zpl?id=pdf-2-zpl) + * [Protection](v2/features/protection.md?id=protection) + * [QR Code](v2/features/qrcode.md?id=qrcode) + * [Signature](v2/features/signature.md?id=signature) + * [Text](v2/features/text.md?id=text) + * [Unit Testing](v2/features/unittests.md?id=unit-testing)