Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bokuweb/docx-rs
:memo: A .docx file writer with Rust/WebAssembly.
https://github.com/bokuweb/docx-rs
Last synced: 19 days ago
JSON representation
:memo: A .docx file writer with Rust/WebAssembly.
- Host: GitHub
- URL: https://github.com/bokuweb/docx-rs
- Owner: bokuweb
- License: mit
- Created: 2019-09-11T16:08:49.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T15:58:48.000Z (about 1 month ago)
- Last Synced: 2024-10-04T19:32:07.327Z (about 1 month ago)
- Language: Rust
- Homepage: https://bokuweb.github.io/docx-rs/
- Size: 11.9 MB
- Stars: 342
- Watchers: 10
- Forks: 60
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
A .docx file `writer` with Rust/WebAssembly.
---
[](https://github.com/bokuweb/docx-rs/actions)
[](https://crates.io/crates/docx-rs)
[](https://www.npmjs.com/package/docx-wasm)
## Installation
### Rust
```
[dependencies]
docx-rs = "0.4"
```
### Browser/Node.js
```
$ yarn add docx-wasm
```
## Example
### Rust
```rust
use docx_rs::*;
pub fn hello() -> Result<(), DocxError> {
let path = std::path::Path::new("./hello.docx");
let file = std::fs::File::create(path).unwrap();
Docx::new()
.add_paragraph(Paragraph::new().add_run(Run::new().add_text("Hello")))
.build()
.pack(file)?;
Ok(())
}
```
### Browser
```javascript
import { saveAs } from "file-saver";
// // Note that a dynamic `import` statement here is required due to webpack/webpack#6615,
import("docx-wasm").then((w) => {
const { buffer } = new w.Docx()
.addParagraph(
new w.Paragraph().addRun(new w.Run().addText("Hello world!!"))
)
.build();
saveAs(new Blob([buffer]), "hello.docx");
});
```
### Node.js
```javascript
const w = require("docx-wasm");
const { writeFileSync } = require("fs");
const { buffer } = new w.Docx()
.addParagraph(new w.Paragraph().addRun(new w.Run().addText("Hello world!!")))
.build();
writeFileSync("hello.docx", Buffer.from(buffer));
```
### More examples
- [Minimum](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/hello.rs)
- [Indent](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/indent.rs)
- [Alignment](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/alignment.rs)
- [Font](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/font.rs)
- [Numbering](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/numbering.rs)
- [Table](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/table.rs)
- [Comment](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/comment.rs)
- [Image](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/image_inline.rs)
- [History](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/history.rs)
## Development
### Requirements
- Node.js 16+
- yarn 1+
- wasm-pack0.10.1 (https://rustwasm.github.io/wasm-pack/)
- insta (https://github.com/mitsuhiko/insta)
### Examples
You can run example with following code.
Please see `examples` directory.
```sh
$ cargo run --example [EXAMPLE_NAME]
```
For Example if you want to run `hello` example.
Please run following command.
```sh
$ cargo run --example hello
```
So you can see output file in output directory.
### Testing
#### Rust
Please run following command.
```
make lint && make test
```
If snapshot testing is failed, fix code or update snapshot files. (See https://insta.rs/).
```
$ cargo-insta review
```
Then re run test.
```
$ make test
```
#### Wasm
Please run following command.
```
$ cd docx-wasm && yarn install && yarn test
```
If snapshot testing is failed, fix code or update snapshot files. (See https://jestjs.io/docs/snapshot-testing).
```
$ yarn test -- --updateSnapshot
```
## Features
- [x] Paragraph
- [x] Alignment
- [x] Indent
- [x] Numbering
- [x] Run
- [x] Bold
- [x] Size
- [x] Font
- [x] Color
- [x] Highlight
- [x] Underline
- [x] vanish
- [x] Italic
- [x] TextBorder
- [x] Footnote
- [x] Break
- [x] Header
- [x] Footer
- [x] Comment
- [x] Image
- [x] Style
- [x] Table
- [x] HIstory
- [x] Table of contents
- [ ] Section
- [ ] Textbox