Skip to content

Commit 8ead9d0

Browse files
committed
fix CI
1 parent c362a24 commit 8ead9d0

File tree

2 files changed

+29
-14
lines changed

2 files changed

+29
-14
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ jobs:
1010
yarn install
1111
- name: Generate
1212
run: |
13-
yarn generate
13+
yarn build

README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
# Mergin Maps Documentation
55

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)
88

99
Source code for documentation hosted on [merginmaps.com/docs](https://merginmaps.com/docs)
1010

@@ -65,31 +65,46 @@ type is one of "tip"|"warning"|"error", see [vuepress docs](https://v1.vuepress.
6565
- Place images next a markdown file that uses it
6666
- Do not start with `/`, use relative paths
6767

68-
e.g. `![](./cloudmergin.png` if the image is in the same folder as your mardown file
68+
e.g. `![](./cloudmergin.png)` if the image is in the same folder as your mardown file
6969

70-
## Embed YouTube content
70+
## Links
7171

72-
Use `<YouTube>` component, e.g. `<YouTube id="DQXrINUqiFI"></YouTube>`
73-
74-
## Reference other markdowns
72+
### Reference other markdowns
7573

7674
- use relative path to the current file
7775
- add `.md` extension
7876
- use `#` for anchors
7977

8078
e.g. `[see this](../web/otherfile.md#permissions)`
8179

82-
e.g. `[](../mobile/othermarkdown.md)
80+
## Custom Components
8381

84-
## Translations (i18n)
82+
see `src/.vuepress/components`
8583

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 />`
8786

87+
### Reference QGIS Help pages
8888

89-
## Vue custom components
89+
Use `<QGISHelp>` component, e.g. `<QGISHelp ver="3.10" link="user_docs/intro.html" text="See QGIS Help page">`
9090

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
93108

94109
# License
95110

0 commit comments

Comments
 (0)