From b99d1fc1291244fa6617593a46dc048535a338c7 Mon Sep 17 00:00:00 2001 From: Dolan Date: Wed, 6 Mar 2019 00:18:00 +0000 Subject: [PATCH] correctly use include --- docs/examples.md | 48 ++++++++++++++++----------------- docs/usage/images.md | 6 ++--- docs/usage/page-numbers.md | 2 +- docs/usage/table-of-contents.md | 2 +- docs/usage/tables.md | 18 ++++++------- 5 files changed, 38 insertions(+), 38 deletions(-) diff --git a/docs/examples.md b/docs/examples.md index 5964aecafe..89e5d4afda 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -14,7 +14,7 @@ This command will run the `demo selector app` in the `/demo` folder. It will pro A simple hello world of the `docx` library: -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo1.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo1.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo1.ts_ @@ -24,7 +24,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo1.ts_ This example shows how to customise the look and feel of a document using JS configuration -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo2.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo2.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo2.ts_ @@ -32,7 +32,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo2.ts_ This example shows how to customise the look and feel of a document using XML configuration -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo13.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo13.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo13.ts_ @@ -40,7 +40,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo13.ts_ This example shows many levels of numbering -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo3.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo3.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo3.ts_ @@ -48,7 +48,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo3.ts_ Example of simple table -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo4.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo4.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo4.ts_ @@ -56,7 +56,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo4.ts_ Styling the borders of a table -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo20.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo20.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo20.ts_ @@ -66,7 +66,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo20.ts_ Importing Images from file system path -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_ @@ -74,7 +74,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_ Example showing how to add image to headers and footers -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_ @@ -82,7 +82,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_ Example showing how to scale images -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo12.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo12.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo12.ts_ @@ -90,7 +90,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo12.ts_ This is the best way to add an image to a document because you can add the same image in two locations without increasing document size by re-using the same image -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo23.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo23.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo23.ts_ @@ -98,7 +98,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo23.ts_ As before, to add an image to a table, you would need to add it to the `Media` object first -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo24.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo24.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo24.ts_ @@ -106,7 +106,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo24.ts_ If you want to use a Base64 image instead -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo18.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo18.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo18.ts_ @@ -114,7 +114,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo18.ts_ Example showing how to set custom margains -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo6.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo6.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo6.ts_ @@ -122,7 +122,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo6.ts_ Example showing how to set the document to `landscape` or `portrait` -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo7.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo7.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo7.ts_ @@ -130,7 +130,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo7.ts_ Example showing how to add headers and footers -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo8.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo8.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo8.ts_ @@ -144,7 +144,7 @@ Check out `Sections` for this feature Example showing how to page break -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo14.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo14.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo14.ts_ @@ -152,7 +152,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo14.ts_ Example showing how to page break before like in Word -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo15.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo15.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo15.ts_ @@ -161,7 +161,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo15.ts_ Example of how sections work. Sections allow multiple headers and footers, and `landscape`/`portrait` inside the same document. Also you can have different page number formats and starts for different sections. -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo16.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo16.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo16.ts_ @@ -169,7 +169,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo16.ts_ Example of how to add footnotes. Good for references -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo17.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo17.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo17.ts_ @@ -179,7 +179,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo17.ts_ Example showing how to use the Buffer packer and then write that buffer to the file system -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo19.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo19.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo19.ts_ @@ -188,7 +188,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo19.ts_ Example showing how to make bookmarks to make internal hyperlinks within the document -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo21.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo21.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo21.ts_ @@ -196,7 +196,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo21.ts_ Example showing how to use bidirectional text for certain languages such as Hebrew -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo22.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo22.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo22.ts_ @@ -206,7 +206,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo22.ts_ Example showing how to add headers and footers -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo10.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo10.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo10.ts_ @@ -214,6 +214,6 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo10.ts_ This example shows how to customise the look and feel of a document and add images -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo11.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo11.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo11.ts_ diff --git a/docs/usage/images.md b/docs/usage/images.md index e25bdd5d85..8f4c34643c 100644 --- a/docs/usage/images.md +++ b/docs/usage/images.md @@ -210,7 +210,7 @@ doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, { Importing Images from file system path -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_ @@ -218,7 +218,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_ Example showing how to add image to headers and footers -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_ @@ -226,6 +226,6 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_ Example showing how to float images on top of text and optimally give a `margin` -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo38.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo38.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo38.ts_ diff --git a/docs/usage/page-numbers.md b/docs/usage/page-numbers.md index f26a9a42b5..5ff66ae50c 100644 --- a/docs/usage/page-numbers.md +++ b/docs/usage/page-numbers.md @@ -61,6 +61,6 @@ doc.Header.createParagraph().addRun(new TextRun("Page ").pageNumber()).addRun(ne Adding page numbers to Header and Footer -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo39.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo39.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo39.ts_ diff --git a/docs/usage/table-of-contents.md b/docs/usage/table-of-contents.md index 7c226833cd..c1fb439143 100644 --- a/docs/usage/table-of-contents.md +++ b/docs/usage/table-of-contents.md @@ -71,6 +71,6 @@ doc.addParagraph(new Paragraph("My Spectacular Style #1").style("MySpectacularSt ### Complete example -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo28.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo28.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo28.ts_ diff --git a/docs/usage/tables.md b/docs/usage/tables.md index 3629757341..94e95ac3e7 100644 --- a/docs/usage/tables.md +++ b/docs/usage/tables.md @@ -195,7 +195,7 @@ cell.addTable(new Table(1, 1)); ## Examples -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo4.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo4.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo4.ts_ @@ -203,7 +203,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo4.ts_ Example showing how to add colourful borders to tables -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo20.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo20.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo20.ts_ @@ -211,11 +211,11 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo20.ts_ Example showing how to add images to tables -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo24.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo24.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo24.ts_ -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/36.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/36.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/36.ts_ @@ -223,7 +223,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/36.ts_ Example showing how align text in a table cell -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo31.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo31.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo31.ts_ @@ -231,11 +231,11 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo31.ts_ Example showing merging of `rows` -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo32.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo32.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo32.ts_ -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo41.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo41.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo41.ts_ @@ -243,13 +243,13 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo41.ts_ Example showing merging of `columns` -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo43.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo43.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo43.ts_ ### Floating tables -[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo34.ts ":include") +[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo34.ts ':include') _Source: https://github.com/dolanmiu/docx/blob/master/demo/demo34.ts_