Skip to content

Commit b267492

Browse files
committed
Update README and manpage.
1 parent 63d20cb commit b267492

2 files changed

Lines changed: 27 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Transform your plain text documents into beautiful HTML documents with customiza
77
## Why Mint?
88

99
- **Focus on writing** – Keep documents as plain text
10-
- **Beautiful output** – Professional-looking HTML ready for print or web
11-
- **Digital gardens**Easily publish linked sets of HTML documents from tools like Obsidian
10+
- **Beautiful output by default** – Professional-looking HTML ready for print or web
11+
- **Customizable**Create your own templates and styles
1212
- **Version control-friendly** – Text documents work great with Git
1313
- **Scriptable** – Automate document processing and analysis
14-
- **Highly customizable**Create your own templates and styles
14+
- **Native support for digital gardens**Easily publish linked sets of HTML documents from tools like Obsidian
1515

1616
## Installation
1717

@@ -42,6 +42,12 @@ same thing.
4242
### Basic commands
4343

4444
```bash
45+
# Preview a document in the browser on a local server
46+
mint Document.md --serve
47+
48+
# Preview on a specific port
49+
mint Document.md --serve --serve-port 8080
50+
4551
# Publish a single document with a default template
4652
mint Document.md
4753

@@ -73,6 +79,8 @@ mint content/**/*.md --destination public --no-preserve-structure
7379

7480
| Flag | Description |
7581
|------|-------------|
82+
| `--serve` | Publish files and preview them on a local HTTP server |
83+
| `--serve-port PORT` | Port for the local server (default: 4000) |
7684
| `-t, --template TEMPLATE` | Use a built-in template (combines layout + style) |
7785
| `-l, --layout LAYOUT` | Specify only the template layout, by name |
7886
| `-s, --style STYLE` | Specify only the template style, by name |
@@ -159,14 +167,6 @@ The `original` mode is particularly useful for template development, as it allow
159167
files and see changes immediately without republishing. In this mode, `@import` statements in CSS
160168
files will be included as additional `<link>` tags.
161169

162-
## Contributing
163-
164-
1. Fork the repository
165-
2. Create a feature branch
166-
3. Make your changes
167-
4. Run the tests: `rspec`
168-
5. Submit a pull request
169-
170170
## License
171171

172172
MIT License. See [LICENSE](LICENSE) for details.

man/mint.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ Mint transforms your plain text documents into beautiful documents. It makes tha
1111
.BR \-h ", " \-\-help
1212
Show mint usage information
1313
.TP
14+
.BR \-\-serve
15+
Publish files to a temporary directory and serve them on a local HTTP server. The server strips \fI.html\fR extensions from URLs so that \fI/document\fR serves \fIdocument.html\fR. The temporary directory is deleted when the server is stopped. This option forces inline style mode so that CSS is always self-contained.
16+
.TP
17+
.BR \-\-serve\-port " " \fIPORT\fR
18+
Port for the local server started by \fB--serve\fR. Default is 4000.
19+
.TP
1420
.BR \-d ", " \-\-destination " " \fIDIRECTORY\fR
1521
Specify a destination directory
1622
.TP
@@ -102,6 +108,16 @@ mint Document.md --opt navigation-depth=4
102108
.RE
103109
.SH EXAMPLES
104110
.TP
111+
Preview a document in the browser:
112+
.nf
113+
mint Document.md --serve
114+
.fi
115+
.TP
116+
Preview on a specific port:
117+
.nf
118+
mint Document.md --serve --serve-port 8080
119+
.fi
120+
.TP
105121
Transform a single Markdown file:
106122
.nf
107123
mint Document.md

0 commit comments

Comments
 (0)