readme formatting fixes

alabaki · Jan 2, 2020 · a9465fd · a9465fd
1 parent d1cadac
commit a9465fd
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 60 deletions.
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -1,7 +1,7 @@
 {
-  "printWidth": 150,
-  "useTabs": true,
-  "tabWidth": 4,
-  "semi": false,
-  "singleQuote": true
+  "printWidth": 100,
+  "useTabs": false,
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": false
 }
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 </h5>
 <p align="center">
   <a href="https://github.com/gitbrent/PptxGenJS/">
-    <img alt="PptxGenJS" title="PptxGenJS" src="https://raw.githubusercontent.com/gitbrent/PptxGenJS/gh-pages/img/readme_banner.jpg" width="800"/>
+    <img alt="PptxGenJS Sample Slides" title="PptxGenJS Sample Slides" src="https://raw.githubusercontent.com/gitbrent/PptxGenJS/gh-pages/img/readme_banner.jpg"/>
   </a>
 </p>
 <br/>
@@ -46,34 +46,35 @@ This library creates Open Office XML (OOXML) Presentations which are compatible
 
 **Modern architecture**
 
--   Supports client web browsers, NodeJS, and React/Angular/Electron
--   Save/stream methods return a promise
--   Easy Angular/React integration (available via npm, cjs or es files)
--   Only a single dependency (JSZip)
+- Supports client web browsers, NodeJS, and React/Angular/Electron
+- Save/stream methods return a promise
+- Easy Angular/React integration (available via npm, cjs or es files)
+- Only a single dependency (JSZip)
+- Typescript definitions are included
 
 **Extensive browser support**
 
--   Create/download presentations on all current desktop & mobile web browsers
--   IE11 is supported (requires included Promises polyfill)
+- Create/download presentations on all current desktop & mobile web browsers
+- IE11 is supported (requires included Promises polyfill)
 
 **Major PowerPoint object types**
 
--   Slides can include Charts, Images, Media, Shapes, Tables, Text and more.
--   SVG images (PowerPoint online and 2019+ desktop)
+- Slides can include Charts, Images, Media, Shapes, Tables, Text and more.
+- SVG images (PowerPoint online and 2019+ desktop)
 
 **HTML to PowerPoint**
 
--   Includes powerful [HTML-to-PowerPoint](#html-to-powerpoint-feature) feature to transform any HTML table into a presentation
+- Includes powerful [HTML-to-PowerPoint](#html-to-powerpoint-feature) feature to transform any HTML table into a presentation
 
 # Live Demo
 
 Use JavaScript to create a PowerPoint presentation with your web browser right now!
 
--   [https://gitbrent.github.io/PptxGenJS](https://gitbrent.github.io/PptxGenJS)
+- [https://gitbrent.github.io/PptxGenJS](https://gitbrent.github.io/PptxGenJS)
 
 The complete library demo is also online.
 
--   [https://gitbrent.github.io/PptxGenJS/demo/](https://gitbrent.github.io/PptxGenJS/demo/)
+- [https://gitbrent.github.io/PptxGenJS/demo/](https://gitbrent.github.io/PptxGenJS/demo/)
 
 # Installation
 
@@ -111,8 +112,8 @@ npm install pptxgenjs --save
 ```
 
 ```javascript
-let PptxGenJS = require('pptxgenjs')
-let pptx = new PptxGenJS()
+let PptxGenJS = require("pptxgenjs");
+let pptx = new PptxGenJS();
 ```
 
 ## Yarn
@@ -123,8 +124,8 @@ yarn add pptxgenjs
 
 ## Additional Builds
 
--   CommonJS: `dist/pptxgenjs.cjs.js`
--   ES Module: `dist/pptxgenjs.es.js`
+- CommonJS: `dist/pptxgenjs.cjs.js`
+- ES Module: `dist/pptxgenjs.es.js`
 
 ---
 
@@ -140,10 +141,14 @@ PptxGenJS PowerPoint presentations are created via JavaScript by following 4 bas
 4. Save the Presentation
 
 ```javascript
-let pptx = new PptxGenJS()
-let slide = pptx.addSlide()
-slide.addText('Hello World from PptxGenJS!', { x: 1, y: 1, w: '80%', h: 3, color: '363636', align: 'center', fill: 'f1f1f1' })
-pptx.writeFile('Sample Presentation')
+let pptx = new PptxGenJS();
+let slide = pptx.addSlide();
+
+let textboxText = "Hello World from PptxGenJS!";
+let textboxOpts = { x: 1, y: 1, align: "center", color: "363636", fill: "f1f1f1" };
+slide.addText(textboxText, textboxOpts);
+
+pptx.writeFile("Sample Presentation");
 ```
 
 That's really all there is to it!
@@ -154,24 +159,22 @@ That's really all there is to it!
 
 Full documentation and code examples are available
 
--   [Creating a Presentation](https://gitbrent.github.io/PptxGenJS/docs/usage-pres-create.html)
--   [Presentation Options](https://gitbrent.github.io/PptxGenJS/docs/usage-pres-options.html)
--   [Adding a Slide](https://gitbrent.github.io/PptxGenJS/docs/usage-add-slide.html)
--   [Slide Options](https://gitbrent.github.io/PptxGenJS/docs/usage-slide-options.html)
--   [Saving a Presentation](https://gitbrent.github.io/PptxGenJS/docs/usage-saving.html)
--   [Master Slides](https://gitbrent.github.io/PptxGenJS/docs/masters.html)
--   [Adding Charts](https://gitbrent.github.io/PptxGenJS/docs/api-charts.html)
--   [Adding Images](https://gitbrent.github.io/PptxGenJS/docs/api-images.html)
--   [Adding Media](https://gitbrent.github.io/PptxGenJS/docs/api-media.html)
--   [Adding Shapes](https://gitbrent.github.io/PptxGenJS/docs/api-shapes.html)
--   [Adding Tables](https://gitbrent.github.io/PptxGenJS/docs/api-tables.html)
--   [Adding Text](https://gitbrent.github.io/PptxGenJS/docs/api-text.html)
--   [Speaker Notes](https://gitbrent.github.io/PptxGenJS/docs/speaker-notes.html)
--   [Using Scheme Colors](https://gitbrent.github.io/PptxGenJS/docs/shapes-and-schemes.html)
--   [Creating a Presentation](https://gitbrent.github.io/PptxGenJS/docs/installation.html)
--   [Integration with Other Libraries](https://gitbrent.github.io/PptxGenJS/docs/integration.html)
-
-Note: Typescript Definitions are included
+- [Creating a Presentation](https://gitbrent.github.io/PptxGenJS/docs/usage-pres-create.html)
+- [Presentation Options](https://gitbrent.github.io/PptxGenJS/docs/usage-pres-options.html)
+- [Adding a Slide](https://gitbrent.github.io/PptxGenJS/docs/usage-add-slide.html)
+- [Slide Options](https://gitbrent.github.io/PptxGenJS/docs/usage-slide-options.html)
+- [Saving a Presentation](https://gitbrent.github.io/PptxGenJS/docs/usage-saving.html)
+- [Master Slides](https://gitbrent.github.io/PptxGenJS/docs/masters.html)
+- [Adding Charts](https://gitbrent.github.io/PptxGenJS/docs/api-charts.html)
+- [Adding Images](https://gitbrent.github.io/PptxGenJS/docs/api-images.html)
+- [Adding Media](https://gitbrent.github.io/PptxGenJS/docs/api-media.html)
+- [Adding Shapes](https://gitbrent.github.io/PptxGenJS/docs/api-shapes.html)
+- [Adding Tables](https://gitbrent.github.io/PptxGenJS/docs/api-tables.html)
+- [Adding Text](https://gitbrent.github.io/PptxGenJS/docs/api-text.html)
+- [Speaker Notes](https://gitbrent.github.io/PptxGenJS/docs/speaker-notes.html)
+- [Using Scheme Colors](https://gitbrent.github.io/PptxGenJS/docs/shapes-and-schemes.html)
+- [Creating a Presentation](https://gitbrent.github.io/PptxGenJS/docs/installation.html)
+- [Integration with Other Libraries](https://gitbrent.github.io/PptxGenJS/docs/integration.html)
 
 ---
 
@@ -180,15 +183,15 @@ Note: Typescript Definitions are included
 Easily convert HTML tables to PowerPoint presentations in a single call.
 
 ```javascript
-var pptx = new PptxGenJS()
-pptx.tableToSlides('tableId')
-pptx.writeFile('HTML-table.pptx')
+var pptx = new PptxGenJS();
+pptx.tableToSlides("tableId");
+pptx.writeFile("HTML-table.pptx");
 ```
 
 Learn more:
 
--   [HTML-to-PowerPoint Documentation](https://gitbrent.github.io/PptxGenJS/docs/html-to-powerpoint.html)
--   [Online HTML-to-PowerPoint Demo](https://gitbrent.github.io/PptxGenJS/demo/#tab2)
+- [HTML-to-PowerPoint Documentation](https://gitbrent.github.io/PptxGenJS/docs/html-to-powerpoint.html)
+- [Online HTML-to-PowerPoint Demo](https://gitbrent.github.io/PptxGenJS/demo/#tab2)
 
 ---
 
@@ -208,8 +211,8 @@ Sometimes implementing a new library can be a difficult task and the slightest m
 If you are having issues getting a presentation to generate, check out the code in the `demos` directory. There
 are demos for both client browsers, node and react that contain working examples of every available library feature.
 
--   Use a pre-configured jsFiddle to test with: [PptxGenJS Fiddle](https://jsfiddle.net/gitbrent/L1uctxm0/)
--   [View questions tagged `PptxGenJS` on StackOverflow](https://stackoverflow.com/questions/tagged/pptxgenjs?sort=votes&pageSize=50). If you can't find your question, [ask it yourself](https://stackoverflow.com/questions/ask?tags=PptxGenJS) - be sure to tag it `PptxGenJS`.
+- Use a pre-configured jsFiddle to test with: [PptxGenJS Fiddle](https://jsfiddle.net/gitbrent/L1uctxm0/)
+- [View questions tagged `PptxGenJS` on StackOverflow](https://stackoverflow.com/questions/tagged/pptxgenjs?sort=votes&pageSize=50). If you can't find your question, [ask it yourself](https://stackoverflow.com/questions/ask?tags=PptxGenJS) - be sure to tag it `PptxGenJS`.
 
 ---
 
@@ -220,10 +223,10 @@ are not on the development roadmap.
 
 These include:
 
--   Animations
--   Importing Existing Presentations and/or Templates
--   Outlines
--   SmartArt
+- Animations
+- Importing Existing Presentations and/or Templates
+- Outlines
+- SmartArt
 
 ---
 
@@ -233,12 +236,12 @@ Thank you to everyone for the issues, contributions and suggestions! ❤️
 
 Special Thanks:
 
--   [Dzmitry Dulko](https://github.com/DzmitryDulko) - Getting the project published on NPM
--   [Michal Kacerovský](https://github.com/kajda90) - New Master Slide Layouts and Chart expertise
--   [Connor Bowman](https://github.com/conbow) - Adding Placeholders
--   [Reima Frgos](https://github.com/ReimaFrgos) - Multiple chart and general functionality patches
--   [Matt King](https://github.com/kyrrigle) - Chart expertise
--   [Mike Wilcox](https://github.com/clubajax) - Chart expertise
+- [Dzmitry Dulko](https://github.com/DzmitryDulko) - Getting the project published on NPM
+- [Michal Kacerovský](https://github.com/kajda90) - New Master Slide Layouts and Chart expertise
+- [Connor Bowman](https://github.com/conbow) - Adding Placeholders
+- [Reima Frgos](https://github.com/ReimaFrgos) - Multiple chart and general functionality patches
+- [Matt King](https://github.com/kyrrigle) - Chart expertise
+- [Mike Wilcox](https://github.com/clubajax) - Chart expertise
 
 PowerPoint shape definitions and some XML code via [Officegen Project](https://github.com/Ziv-Barber/officegen)