From 7968922f416146c87d5d6aa4f6e415603d210424 Mon Sep 17 00:00:00 2001 From: Hsieh Chin Fan Date: Fri, 11 Oct 2024 17:12:31 +0800 Subject: feat: update tutorial content for adding GeoLink * add new module for hoding contents * also add settings for linkify --- src/tutorial.mjs | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 src/tutorial.mjs (limited to 'src/tutorial.mjs') diff --git a/src/tutorial.mjs b/src/tutorial.mjs new file mode 100644 index 0000000..15d5779 --- /dev/null +++ b/src/tutorial.mjs @@ -0,0 +1,62 @@ +export const md = ` +>
Hello My Friend! This is DumbyMap!

+ +\`\`\`map +use: Maplibre +height: 120px +style: https://tile.openstreetmap.jp/styles/openmaptiles/style.json +\`\`\` + + +DumbyMap generates **interactive document with maps** from raw texts. + +You can use it to: + +1. [Roll a Dice] for a new map +2. Hover on [GeoLink][example-geolink] to show point in maps. +3. Add GeoLink by dragging **selected text** +4. Change contents by [Editor] with [Markdown] text +5. **Right click** to call context menu, you can: + + Change focus between maps + + Select a block for browsing + + Switch layouts for various use cases + + +If you want know more, take a look at subjects below: +1. [How to write Markdown text?](https://www.markdownguide.org/basic-syntax/) +1.
+ How to add GeoLink in Markdown + + The following formats are valid for GeoLink: + 1. Surround coordinated with parenthesis: \`(, )\` or \`(/)\` + For example: (121,23) + 2. Have leading \`@\` symbol: \`@,\` or \`@/\` + For example: @121/23 + 3. Use geo URI scheme: \`geo:,\` + For example: geo:23,121 +
+1.
+ How can I save contents for next use? + + Since All contents come from raw texts, you can: + 1. Save current page as bookmark by [hash button](#create-hash "=>.mde-hash") + 2. Copy texts in editor and save as \`.txt\` file + 3. Use online service for hosting Markdown, for example: [HackMD](https://hackmd.io) +
+1.
+ I want more features in map! + + DumbyMap use [mapclay](https://github.com/outdoorsafetylab/mapclay) to render maps. + 1. You can use \`eval\` options to add custom scripts, see [tutorial](https://github.com/outdoorsafetylab/mapclay?tab=readme-ov-file#run-scripts-after-map-is-created) for more details + 2. You can use custom Renderer indtead of default ones, see [tutorial](https://github.com/outdoorsafetylab/mapclay?tab=readme-ov-file#renderer) for more details +
+1. [I am an experienced developer, show me what you got!](https://github.com/outdoorsafetylab/dumbymap) + + + +>
Have Fun ~

+ +[Roll a Dice]: #Click%20it! "=>.mde-roll" +[example-geolink]: geo:24,121?xy=121,24&text=Use%20yellow%20link%20point%20to%20map +[Markdown]: https://www.markdownguide.org/basic-syntax/ +[Editor]: #This%20is%20editor! "=>.editor"` -- cgit v1.2.3-70-g09d2