diff options
author | Hsieh Chin Fan <pham@topo.tw> | 2024-10-11 17:13:23 +0800 |
---|---|---|
committer | Hsieh Chin Fan <pham@topo.tw> | 2024-10-11 17:33:01 +0800 |
commit | 1e58074339d93a302e29ea50b2860d8840b229ec (patch) | |
tree | 2cdee62dff1a25552324ea66c049601e7ee7c059 /README.md | |
parent | 7968922f416146c87d5d6aa4f6e415603d210424 (diff) |
docs: add doc page
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 10 |
1 files changed, 6 insertions, 4 deletions
@@ -1,12 +1,15 @@ | |||
1 | # Dumbymap | 1 | # Dumbymap |
2 | 2 | ||
3 | This library generate web maps from [Semantic HTML], play around with [demo page](https://outdoorsafetylab.github.io/dumbymap/) | 3 | This library generate web maps from [Semantic HTML], just play around with [demo page](https://outdoorsafetylab.github.io/dumbymap/) |
4 | 4 | ||
5 | > [!CAUTION] | 5 | > [!CAUTION] |
6 | > API of DumbyMap is not stable now, use it carefully | 6 | > DumbyMap is not in production stage. API is not stable now, use it carefully |
7 | 7 | ||
8 | ## Getting Started | 8 | ## Getting Started |
9 | 9 | ||
10 | Browser (CDN): | ||
11 | - unpkg: https://unpkg.com/dumbymap@latest/dist/dumbymap.mjs | ||
12 | |||
10 | Node.js: | 13 | Node.js: |
11 | 14 | ||
12 | ```bash | 15 | ```bash |
@@ -26,8 +29,7 @@ markdown2HTML(container, '# Heading\n\n```map\nid: foo\nuse: Maplibre\n```\n') | |||
26 | const dumbymap = generateMaps(container, options ?? {}) | 29 | const dumbymap = generateMaps(container, options ?? {}) |
27 | ``` | 30 | ``` |
28 | 31 | ||
29 | Browser (CDN): | 32 | For more information, please visie [docs page](https://outdoorsafetylab.github.io/dumbymap/docs/global.html#generateMaps) |
30 | - unpkg: https://unpkg.com/dumbymap@latest/dist/dumbymap.mjs | ||
31 | 33 | ||
32 | 34 | ||
33 | ## Semantic HTML | 35 | ## Semantic HTML |