Project rename
All checks were successful
CI Pipeline / build (push) Successful in 12s

This commit is contained in:
2025-12-02 13:21:13 +01:00
parent 29ebb9a8d1
commit dec346254c
36 changed files with 114 additions and 114 deletions

View File

@@ -1,4 +1,4 @@
# Ezdoc
# Notare
A Ruby gem for creating docx files with a simple DSL
@@ -7,7 +7,7 @@ A Ruby gem for creating docx files with a simple DSL
Add this line to your application's Gemfile:
```ruby
gem 'ezdoc'
gem 'notare'
```
And then execute:
@@ -16,16 +16,16 @@ And then execute:
Or install it yourself as:
$ gem install ezdoc
$ gem install notare
## Usage
### Basic Example
```ruby
require 'ezdoc'
require 'notare'
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
doc.p "Hello World"
end
```
@@ -33,7 +33,7 @@ end
### Paragraphs
```ruby
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
# Simple paragraph
doc.p "This is a paragraph."
@@ -50,7 +50,7 @@ end
Formatting uses nested blocks. Nesting combines formatting styles.
```ruby
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
doc.p do
doc.text "Normal text "
doc.b { doc.text "bold" }
@@ -74,7 +74,7 @@ end
Use `h1` through `h6` for document headings:
```ruby
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
doc.h1 "Document Title"
doc.h2 "Chapter 1"
doc.h3 "Section 1.1"
@@ -92,12 +92,12 @@ end
### Styles
Ezdoc includes built-in styles and supports custom style definitions.
Notare includes built-in styles and supports custom style definitions.
#### Built-in Styles
```ruby
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
doc.p "This is a title", style: :title
doc.p "A subtitle", style: :subtitle
doc.p "A quotation", style: :quote
@@ -110,7 +110,7 @@ end
Define your own styles with text and paragraph properties:
```ruby
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
# Define custom styles
doc.define_style :warning,
bold: true,
@@ -161,7 +161,7 @@ end
#### Bullet Lists
```ruby
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
doc.ul do
doc.li "First item"
doc.li "Second item"
@@ -173,7 +173,7 @@ end
#### Numbered Lists
```ruby
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
doc.ol do
doc.li "First"
doc.li "Second"
@@ -185,7 +185,7 @@ end
### Tables
```ruby
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
doc.table do
doc.tr do
doc.td "Header 1"
@@ -204,7 +204,7 @@ end
Images can be added to paragraphs, table cells, and list items. Supports PNG and JPEG formats.
```ruby
Ezdoc::Document.create("output.docx") do |doc|
Notare::Document.create("output.docx") do |doc|
# Simple image (uses native dimensions)
doc.p do
doc.image "photo.png"
@@ -249,7 +249,7 @@ end
### Complete Example
```ruby
Ezdoc::Document.create("report.docx") do |doc|
Notare::Document.create("report.docx") do |doc|
doc.p "Monthly Report"
doc.p do