docx-rs/README.md

61 lines
1.6 KiB
Markdown
Raw Normal View History

2020-01-17 16:07:44 +02:00
<p align="center"><img src ="https://github.com/bokuweb/docx-rs/blob/master/logo.png?raw=true" /></p>
<p align="center">
A .docx file generater with Rust/WebAssembly.
</p>
---
2019-11-12 06:45:04 +02:00
[![GitHub Actions Status](https://github.com/bokuweb/docx-rs/workflows/Continuous%20Integration/badge.svg)](https://github.com/bokuweb/docx-rs/actions)
2019-11-15 11:15:43 +02:00
2020-01-17 17:19:07 +02:00
## Example
2020-01-24 11:50:16 +02:00
```rust
2020-01-17 17:19:07 +02:00
use docx_core::*;
pub fn hello() -> Result<(), DocxError> {
2020-01-24 11:50:16 +02:00
let path = std::path::Path::new("./hello.docx");
2020-01-17 17:19:07 +02:00
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(())
}
```
2020-01-17 17:20:46 +02:00
### More examples
2020-01-24 11:50:16 +02:00
- [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)
- [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)
- [History](https://github.com/bokuweb/docx-rs/blob/master/docx-core/examples/history.rs)
2020-01-17 17:20:46 +02:00
2020-01-17 17:19:07 +02:00
## Features
2019-11-15 11:15:43 +02:00
- [x] Paragraph
2020-01-24 11:50:16 +02:00
- [x] Alignment
- [x] Indent
- [x] Numbering
- [x] Run
- [x] Bold
- [x] Size
- [x] Color
- [x] Highlight
- [x] Underline
- [x] vanish
- [x] Italic
- [x] Break
- [ ] Header
- [ ] Footer
- [x] Comment
- [ ] Image
- [x] Style
- [x] Table
- [x] HIstory
- [ ] Table of contents
- [ ] Section