From 1e58074339d93a302e29ea50b2860d8840b229ec Mon Sep 17 00:00:00 2001 From: Hsieh Chin Fan Date: Fri, 11 Oct 2024 17:13:23 +0800 Subject: docs: add doc page --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f935e39..47d3542 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ # Dumbymap -This library generate web maps from [Semantic HTML], play around with [demo page](https://outdoorsafetylab.github.io/dumbymap/) +This library generate web maps from [Semantic HTML], just play around with [demo page](https://outdoorsafetylab.github.io/dumbymap/) > [!CAUTION] -> API of DumbyMap is not stable now, use it carefully +> DumbyMap is not in production stage. API is not stable now, use it carefully ## Getting Started +Browser (CDN): +- unpkg: https://unpkg.com/dumbymap@latest/dist/dumbymap.mjs + Node.js: ```bash @@ -26,8 +29,7 @@ markdown2HTML(container, '# Heading\n\n```map\nid: foo\nuse: Maplibre\n```\n') const dumbymap = generateMaps(container, options ?? {}) ``` -Browser (CDN): -- unpkg: https://unpkg.com/dumbymap@latest/dist/dumbymap.mjs +For more information, please visie [docs page](https://outdoorsafetylab.github.io/dumbymap/docs/global.html#generateMaps) ## Semantic HTML -- cgit v1.2.3-70-g09d2