|
3 | 3 |
|
4 | 4 | # Mergin Maps Documentation |
5 | 5 |
|
6 | | -[Staging/Dev deployment](https://dev.d1qvlu9jr497xw.amplifyapp.com/docs) |
7 | | -[Production deployment](https://merginmaps.com/docs) |
| 6 | + - [Staging/Dev deployment](https://dev.d1qvlu9jr497xw.amplifyapp.com/docs) |
| 7 | + - [Production deployment](https://merginmaps.com/docs) |
8 | 8 |
|
9 | 9 | Source code for documentation hosted on [merginmaps.com/docs](https://merginmaps.com/docs) |
10 | 10 |
|
@@ -65,31 +65,46 @@ type is one of "tip"|"warning"|"error", see [vuepress docs](https://v1.vuepress. |
65 | 65 | - Place images next a markdown file that uses it |
66 | 66 | - Do not start with `/`, use relative paths |
67 | 67 |
|
68 | | -e.g. `` if the image is in the same folder as your mardown file |
69 | 69 |
|
70 | | -## Embed YouTube content |
| 70 | +## Links |
71 | 71 |
|
72 | | -Use `<YouTube>` component, e.g. `<YouTube id="DQXrINUqiFI"></YouTube>` |
73 | | - |
74 | | -## Reference other markdowns |
| 72 | +### Reference other markdowns |
75 | 73 |
|
76 | 74 | - use relative path to the current file |
77 | 75 | - add `.md` extension |
78 | 76 | - use `#` for anchors |
79 | 77 |
|
80 | 78 | e.g. `[see this](../web/otherfile.md#permissions)` |
81 | 79 |
|
82 | | -e.g. `[](../mobile/othermarkdown.md) |
| 80 | +## Custom Components |
83 | 81 |
|
84 | | -## Translations (i18n) |
| 82 | +see `src/.vuepress/components` |
85 | 83 |
|
86 | | -see [vuepress docs](https://v1.vuepress.vuejs.org/guide/i18n.html#site-level-i18n-config) |
| 84 | + - add your component to `src/.vuepress/components/MyComponent.vue` |
| 85 | + - use in markdown as `<MyComponent></MyComponent>` or `<MyComponent />` |
87 | 86 |
|
| 87 | +### Reference QGIS Help pages |
88 | 88 |
|
89 | | -## Vue custom components |
| 89 | +Use `<QGISHelp>` component, e.g. `<QGISHelp ver="3.10" link="user_docs/intro.html" text="See QGIS Help page">` |
90 | 90 |
|
91 | | - - add your component to `src/.vuepress/components/MyComponent.vue` |
92 | | - - use in markdown as `<MyComponent></MyComponent>` or `<MyComponent />` |
| 91 | +### Embed YouTube content |
| 92 | + |
| 93 | +Use `<YouTube>` component, e.g. `<YouTube id="DQXrINUqiFI" />` |
| 94 | + |
| 95 | +### Reference Mergin project |
| 96 | + |
| 97 | +Use `<MerginMapsProject>` component, e.g. `<MerginMapsProject id="lutraconsulting/test_forms" />` |
| 98 | + |
| 99 | +### Show Input App Google/Apple badges for download |
| 100 | + |
| 101 | +Use `<AppDownload>` component, e.g. `<AppDownload />` |
| 102 | + |
| 103 | +## Translations (i18n) |
| 104 | + |
| 105 | +see [vuepress docs](https://v1.vuepress.vuejs.org/guide/i18n.html#site-level-i18n-config) |
| 106 | + |
| 107 | +not yet implemented |
93 | 108 |
|
94 | 109 | # License |
95 | 110 |
|
|
0 commit comments