aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/tutorial.mjs
diff options
context:
space:
mode:
Diffstat (limited to 'src/tutorial.mjs')
-rw-r--r--src/tutorial.mjs62
1 files changed, 62 insertions, 0 deletions
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 @@
1export const md = `<!-- banner -->
2> <big><br>Hello My Friend! This is DumbyMap!<br><br></big>
3
4\`\`\`map
5use: Maplibre
6height: 120px
7style: https://tile.openstreetmap.jp/styles/openmaptiles/style.json
8\`\`\`
9
10
11DumbyMap generates **interactive document with maps** from raw texts.
12
13You can use it to:
14
151. [Roll a Dice] for a new map
162. Hover on [GeoLink][example-geolink] to show point in maps.
173. Add GeoLink by dragging **selected text**
184. Change contents by [Editor] with [Markdown] text
195. **Right click** to call context menu, you can:
20 + Change focus between maps
21 + Select a block for browsing
22 + Switch layouts for various use cases
23
24
25If you want know more, take a look at subjects below:
261. [How to write Markdown text?](https://www.markdownguide.org/basic-syntax/)
271. <details>
28 <summary>How to add GeoLink in Markdown</summary>
29
30 The following formats are valid for GeoLink:
31 1. Surround coordinated with parenthesis: \`(<x>, <y>)\` or \`(<x>/<y>)\`
32 For example: (121,23)
33 2. Have leading \`@\` symbol: \`@<x>,<y>\` or \`@<x>/<y>\`
34 For example: @121/23
35 3. Use geo URI scheme: \`geo:<lat>,<lon>\`
36 For example: geo:23,121
37 </details>
381. <details>
39 <summary>How can I save contents for next use?</summary>
40
41 Since All contents come from raw texts, you can:
42 1. Save current page as bookmark by [hash button](#create-hash "=>.mde-hash")
43 2. Copy texts in editor and save as \`.txt\` file
44 3. Use online service for hosting Markdown, for example: [HackMD](https://hackmd.io)
45 </details>
461. <details>
47 <summary>I want more features in map!</summary>
48
49 DumbyMap use [mapclay](https://github.com/outdoorsafetylab/mapclay) to render maps.
50 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
51 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
52 </details>
531. [I am an experienced developer, show me what you got!](https://github.com/outdoorsafetylab/dumbymap)
54
55
56<!-- footer -->
57> <big><br>Have Fun ~<br><br></big>
58
59[Roll a Dice]: #Click%20it! "=>.mde-roll"
60[example-geolink]: geo:24,121?xy=121,24&text=Use%20yellow%20link%20point%20to%20map
61[Markdown]: https://www.markdownguide.org/basic-syntax/
62[Editor]: #This%20is%20editor! "=>.editor"`