xref: /aosp_15_r20/external/cldr/tools/scripts/tr-archive/README.md (revision 912701f9769bb47905792267661f0baf2b85bed5)
1# Unicode TR35 archiver
2
3## What this does
4
5- render `../../../docs/ldml/*.md` into `.html`
6- add some CSS and fixup the HTML a little bit
7- The goal is to create .html suitable to end up at, for example, <https://www.unicode.org/reports/tr35/tr35-61/tr35.html>
8
9## Prerequisites
10
11Node.js (Tested with v12)
12
13## How to use
14
15- To generate the .zip file: (Unix)
16
17```shell
18$ bash make-tr-archive.sh
19```
20
21You will end up with HTML files under `dist/` and a zipped up `./tr35.zip` archive.
22
23- To generate, and also serve locally via a little web server (Unix):
24
25```shell
26$ npm install
27$ npm run serve
28```
29
30`reports.css` gets downloaded locally so that the relative link ( `../reports.css`) within the HTML will work.
31
32
33## Updating ToC
34
35```shell
36$ npm install
37$ npm run fix-tocs
38```
39
40This will update the tr .md files in place.
41### Copyright
42
43Copyright &copy; 1991-2021 Unicode, Inc.
44All rights reserved.
45[Terms of use](https://www.unicode.org/copyright.html)
46
47See [../../../README.md](../../../README.md) for full project information.
48
49