|
| 1 | +# 🔩 mend.html |
| 2 | + |
| 3 | +Mend is a simple HTML template processor designed to, but not limited to be used to generate static websites. |
| 4 | + |
| 5 | +Refer to the [Wiki](https://github.com/bbfh-dev/mend.html/wiki) for in-depth tutorial. |
| 6 | + |
| 7 | +<!-- vim-markdown-toc GFM --> |
| 8 | + |
| 9 | +* [📥 Installation](#-installation) |
| 10 | +* [⚙️ Usage](#-usage) |
| 11 | +* [📌 Developer notes](#-developer-notes) |
| 12 | + |
| 13 | +<!-- vim-markdown-toc --> |
| 14 | + |
| 15 | +- [Wiki / Documentation](https://github.com/bbfh-dev/mend.html/wiki) |
| 16 | + |
| 17 | +# 📥 Installation |
| 18 | + |
| 19 | +Download the [latest release](https://github.com/bbfh-dev/mend.html/releases/latest) or install via the command line with: |
| 20 | + |
| 21 | +```bash |
| 22 | +go install github.com/bbfh-dev/mend.html |
| 23 | +``` |
| 24 | + |
| 25 | +# ⚙️ Usage |
| 26 | + |
| 27 | +Run `mend --help` to display usage information. |
| 28 | + |
| 29 | +```bash |
| 30 | +Usage: |
| 31 | + mend <options> [html files...] |
| 32 | + |
| 33 | +Commands: |
| 34 | + |
| 35 | +Options: |
| 36 | + --help, -h Print help and exit |
| 37 | + --version, -V Print version and exit |
| 38 | + --input, -i <value> Set global input parameters |
| 39 | + --indent <value> Set amount of spaces to indent with. Gets ignored if --tabs is used |
| 40 | + --tabs, -t Use tabs instead of spaces |
| 41 | + --decomment Strips away any comments |
| 42 | +``` |
| 43 | +
|
| 44 | +# 📌 Developer notes |
| 45 | +
|
| 46 | +These are some important development notes, informing about parts of the project that need to be polished out. |
| 47 | +
|
| 48 | +> **Expressions are very clunky.** |
| 49 | +> |
| 50 | +> 1. In code they require every node to implement its own processing while referencing a global function that handles them. Basically, it's just a big bowl of spaghetti. There's gotta be a better way of doing them. |
| 51 | +> 1. The way expressions are parsed is very primitive, it could cause unexpected errors/behavior when using bad syntax. |
| 52 | +> |
| 53 | +> — [@bbfh-dev](https://github.com/bbfh-dev/) |
0 commit comments