Skip to content

Commit e2b3bfd

Browse files
author
Gabe Webb
committed
Updated readme references to documentation.
1 parent e71d217 commit e2b3bfd

File tree

1 file changed

+19
-31
lines changed

1 file changed

+19
-31
lines changed

README.md

+19-31
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,28 @@
11
# DOCX Markup Language
22

3-
This is a [NodeJS](https://nodejs.org/)/[Deno](https://deno.land) module for making `.docx` files from scratch or from
4-
an existing DOCX/DOTX template.
3+
This is a [NodeJS](https://nodejs.org/)/[Deno](https://deno.land) module for making `.docx` documents from scratch or from
4+
an existing `.docx` or `.dotx` template.
55

66
You could use `docxml` to:
77

88
- Create an MS Word file without ever opening MS Word
9-
- Create a parameterized template file, and render it to DOCX with your data parameters
10-
- Convert JSON, XML or other data structures to DOCX
11-
- Parse content from an existing DOCX file
12-
- Extract style definitions from a DOTX/DOCX file
9+
- Create a parameterized template file and render it to `.docx` with your data parameters
10+
- Write JSON, XML or other data structures to `.docx`
11+
- Parse content from an existing `.docx` file
12+
- Extract style information from a `.docx` or `.dotx` file
1313

1414
This documentation for this lib is available at various locations:
1515

16-
[👉 Documentation site](https://wvbe.github.io/docxml)<br />
17-
[👉 GitHub source](http://github.com/wvbe/docxml)<br />
16+
[👉 Documentation site](https://github.com/fontoxml/docxml/wiki)<br />
17+
[👉 GitHub source](http://github.com/fontoxml/docxml)<br />
1818
[👉 Deno mirror](http://deno.land/x/docxml)<br />
1919
[👉 npm mirror](http://npmjs.org/package/docxml)
2020

2121
#### For Deno or for NodeJS
2222

23-
[👉 Main article](./docs/setup/deno-or-node.md)
23+
[👉 Main article](https://github.com/fontoxml/docxml/wiki/Deno-or-Node)
2424

25-
`docxml` can be used in [NodeJS](https://nodejs.org/) and [Deno](https://deno.land) according to the traditions in those
26-
ecosystems. For Node users, simply `npm install docxml` and then `require()` or `import` as you wish. For Deno users,
27-
`import "deno.land/x/docxml/mod.ts"` or use an import map if you wish.
25+
`docxml` can be used in [NodeJS](https://nodejs.org/) and [Deno](https://deno.land) according to the conventions of those ecosystems. For Node users, simply `npm install docxml` and then `require()` or `import` as you wish. For Deno users, `import "deno.land/x/docxml/mod.ts"` or use an import map.
2826

2927
```js
3028
// NodeJS using CommonJS:
@@ -39,10 +37,9 @@ import Docxml, { Paragraph } from 'https://deno.land/x/docxml/mod.ts';
3937

4038
#### For JSX or for vanilla
4139

42-
[👉 Main article](./docs/setup/jsx-or-not.md)
40+
[👉 Main article](https://github.com/fontoxml/docxml/wiki/JSX-or-Not)
4341

44-
`docxml` is designed to be used in vanilla JavaScript using class component instances, or using JSX if you're on Deno or
45-
want to use NodeJS and a transpiler like Babel:
42+
`docxml` is designed to be used in vanilla JavaScript using class component instances, or using JSX if you're on Deno or want to use NodeJS and a transpiler like Babel:
4643

4744
```ts
4845
const para = new Paragraph({ alignment: 'center' }, new Text({}, 'I want a cookie'));
@@ -82,10 +79,10 @@ await Docx.fromNothing()
8279
8380
#### Features
8481
85-
To great or small extend, the following features work in the current version of `docxml`. Some items are not ticked off
82+
To great or small extent, the following features work in the current version of `docxml`. Some items are not ticked off
8683
yet -- they are not available, but hopefully soon.
8784
88-
[👉 See code examples of some or the more intricate features](https://github.com/wvbe/docxml/wiki/Examples)
85+
[👉 See code examples of some or the more intricate features](https://github.com/fontoxml/docxml/wiki/Examples)
8986
9087
**API features:**
9188
@@ -143,22 +140,13 @@ yet -- they are not available, but hopefully soon.
143140
144141
#### Differences with actual MS Word DOCX
145142
146-
Obviously `docxml` is a TypeScript project, which is already very different from how you would normally interact
147-
with a DOCX document. More meaningfully however, `docxml` is meant to make writing DOCX _easier_ than going straight
148-
to OOXML. For example;
149-
150-
- All sizes are of type `Length`, which means it doesn't matter wether you input them as points, centimeters,
151-
inches, 1/2, 1/8th or 1/20th points, English Metric Units, and so on.
152-
- The JSX pragma will try to correct components that would lead to invalid XML structures, by splitting the parents of
153-
invalidly placed components recursively until the new position is valid. Moreover, string content in unexpected places
154-
is automatically wrapped in `<Text>` when using JSX. This makes the configuration of a new DOCX a little more
155-
forgiving.
143+
Obviously `docxml` is a TypeScript project, which is already very different from how you would normally interact with a `.docx` file. More meaningfully however, `docxml` is meant to make writing Word document files _easier_ than going straight to OOXML. For example:
144+
- All sizes are of type `Length`, which means it doesn't matter wether you input them as points, centimeters, inches, 1/2, 1/8th or 1/20th points, English Metric Units, and so on.
145+
- The JSX pragma will try to correct components that would lead to invalid XML structures, by splitting the parents of invalidly placed components recursively until the new position is valid. Moreover, string content in unexpected places is automatically wrapped in `<Text>` when using JSX. This makes the configuration of a new DOCX a little more forgiving.
156146
- Using the `<Image>` or `<Comment>` components will automatically create all required relationships etc.
157147
- Some of the words have changed, generally speaking `docxml` is more verbose than the DOCX verbiage.
158-
- Generally speaking `docxml` prefers formal (JS) references over references-by-identifier. In those cases the
159-
identifiers are randomly generated for you when the `.docx` file is written.
160-
- Especially in tables and images, a lot of formatting details are automatically applied. In a lot of cases there
161-
is no API _yet_ to change them.
148+
- Generally speaking `docxml` prefers formal (JS) references over references-by-identifier. In those cases the identifiers are randomly generated for you when the `.docx` file is written.
149+
- Especially in tables and images, a lot of formatting details are automatically applied. In a lot of cases there is no API _yet_ to change them.
162150

163151
#### For contributors
164152

0 commit comments

Comments
 (0)