Skip to content

Commit 7429868

Browse files
committed
Update documentation for version 1.0-beta-1
1 parent 4435ee4 commit 7429868

27 files changed

+46
-72
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,13 @@ Curious about the implementation? See the sources in our public **[Github reposi
3434

3535
When you are ready, you can get started with by **[setting it up on your project](https://axellience.github.io/vue-gwt/project-setup.html)**.
3636

37-
> ⚠️ Vue GWT is in an **experimental** state.
38-
The syntax is not final and might change between versions.
39-
It may also contain bugs.
37+
>️ ℹ️ Vue GWT is in an **beta** state.
38+
It may still contain some bugs.
4039

4140
> We are looking for feedback and contributions.
4241
If you use it on a small project, please [let us know how it goes](https://gitter.im/Axellience/vue-gwt).
4342

44-
## Who Made This?
43+
## Who made this?
4544

4645
<p align="center">
4746
Vue GWT is developed by the awesome people at<br/>

docs-source/book/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,16 @@ Curious about the implementation? See the sources in our public **[Github reposi
3434

3535
When you are ready, you can get started with by **[setting it up on your project](./project-setup.md)**.
3636

37-
<p class="warning-panel">
38-
Vue GWT is in an <strong>experimental</strong> state.
39-
The syntax is not final and might change between versions.
40-
It may also contain bugs.<br/>
37+
<p class="info-panel">
38+
Vue GWT is in an <strong>beta</strong> state.
39+
It may still contain some bugs.<br/>
4140
We are looking for feedback and contributions.
4241
If you use it on a small project, please <a href="https://gitter.im/Axellience/vue-gwt" target="_blank">let us know how it goes</a>.
4342
</p>
4443

45-
*This documentation was last updated for [Vue.js v2.4.2](https://github.com/vuejs/vue/releases/tag/v2.4.2) and Vue GWT 0.1-SNAPSHOT*
44+
*This documentation was last updated for [Vue.js v2.4.2](https://github.com/vuejs/vue/releases/tag/v2.4.2) and Vue GWT 1.0-beta-1*
4645

47-
## Who Made This?
46+
## Who made this?
4847

4948
<p align="center">
5049
Vue GWT is developed by the awesome people at<br/>

docs-source/book/project-setup.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,14 @@ To add Vue GWT to your Maven project, simply add the following to your `pom.xml`
66

77
```xml
88
<project>
9-
<properties>
10-
...
11-
<vue-gwt.version>0.1-SNAPSHOT</vue-gwt.version>
12-
</properties>
13-
149
<dependencies>
1510
...
1611
<dependency>
1712
<groupId>com.axellience</groupId>
1813
<artifactId>vue-gwt</artifactId>
19-
<version>${vue-gwt.version}</version>
14+
<version>1.0-beta-1</version>
2015
</dependency>
2116
</dependencies>
22-
23-
<!-- For now we only have SNAPSHOT releases, so you need to add the SonaType repository to get them -->
24-
<repositories>
25-
...
26-
<repository>
27-
<id>ossrh</id>
28-
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
29-
</repository>
30-
</repositories>
3117
</project>
3218
```
3319

@@ -59,7 +45,10 @@ First, in the `plugins` section of your Maven `pom.xml` add the following `plugi
5945
```
6046

6147
### Eclipse
62-
If you use Eclipse, you need the following to your `pom.xml` to enable automatic annotation processing:
48+
If you use Eclipse first ensure you have the `m2e-apt` plugin installed:
49+
[https://marketplace.eclipse.org/content/m2e-apt](https://marketplace.eclipse.org/content/m2e-apt).
50+
51+
Then you need to add the following to your `pom.xml` to store the settings of `m2e-apt`:
6352

6453
```xml
6554
<pluginManagement>

docs/advanced/and-more.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -838,7 +838,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
838838
<script>
839839
var gitbook = gitbook || [];
840840
gitbook.push(function() {
841-
gitbook.page.hasChanged({"page":{"title":"And more!","level":"4.7","depth":1,"previous":{"title":"Routing","level":"4.6","depth":1,"path":"advanced/routing.md","ref":"advanced/routing.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["include","toggle-chapters"],"pluginsConfig":{"include":{},"toggle-chapters":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"advanced/and-more.md","mtime":"2017-08-15T19:15:42.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-09-06T09:17:10.167Z"},"basePath":"..","book":{"language":""}});
841+
gitbook.page.hasChanged({"page":{"title":"And more!","level":"4.7","depth":1,"previous":{"title":"Routing","level":"4.6","depth":1,"path":"advanced/routing.md","ref":"advanced/routing.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["include","toggle-chapters"],"pluginsConfig":{"include":{},"toggle-chapters":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"advanced/and-more.md","mtime":"2017-08-15T19:15:42.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-09-07T09:38:34.549Z"},"basePath":"..","book":{"language":""}});
842842
});
843843
</script>
844844
</div>

docs/advanced/custom-directives.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -950,7 +950,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
950950
<script>
951951
var gitbook = gitbook || [];
952952
gitbook.push(function() {
953-
gitbook.page.hasChanged({"page":{"title":"Custom Directives","level":"4.4","depth":1,"next":{"title":"Plugins","level":"4.5","depth":1,"path":"advanced/plugins.md","ref":"advanced/plugins.md","articles":[]},"previous":{"title":"Replacing Template Features with Plain Java","level":"4.3.3","depth":2,"anchor":"#replacing-template-feature-in-java","path":"advanced/render-function.md","ref":"advanced/render-function.md#replacing-template-feature-in-java","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["include","toggle-chapters"],"pluginsConfig":{"include":{},"toggle-chapters":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"advanced/custom-directives.md","mtime":"2017-08-15T17:41:24.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-09-06T09:17:10.167Z"},"basePath":"..","book":{"language":""}});
953+
gitbook.page.hasChanged({"page":{"title":"Custom Directives","level":"4.4","depth":1,"next":{"title":"Plugins","level":"4.5","depth":1,"path":"advanced/plugins.md","ref":"advanced/plugins.md","articles":[]},"previous":{"title":"Replacing Template Features with Plain Java","level":"4.3.3","depth":2,"anchor":"#replacing-template-feature-in-java","path":"advanced/render-function.md","ref":"advanced/render-function.md#replacing-template-feature-in-java","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["include","toggle-chapters"],"pluginsConfig":{"include":{},"toggle-chapters":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"advanced/custom-directives.md","mtime":"2017-08-15T17:41:24.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-09-07T09:38:34.549Z"},"basePath":"..","book":{"language":""}});
954954
});
955955
</script>
956956
</div>

docs/advanced/extending-components.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1001,7 +1001,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
10011001
<script>
10021002
var gitbook = gitbook || [];
10031003
gitbook.push(function() {
1004-
gitbook.page.hasChanged({"page":{"title":"Extending Components","level":"4.2","depth":1,"next":{"title":"Extending Java Components","level":"4.2.1","depth":2,"anchor":"#extending-java-component","path":"advanced/extending-components.md","ref":"advanced/extending-components.md#extending-java-component","articles":[]},"previous":{"title":"Using our Java Components in JS","level":"4.1.2","depth":2,"anchor":"#using-java-components-in-js","path":"advanced/integrating-with-js-components.md","ref":"advanced/integrating-with-js-components.md#using-java-components-in-js","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["include","toggle-chapters"],"pluginsConfig":{"include":{},"toggle-chapters":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"advanced/extending-components.md","mtime":"2017-09-06T08:48:15.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-09-06T09:17:10.167Z"},"basePath":"..","book":{"language":""}});
1004+
gitbook.page.hasChanged({"page":{"title":"Extending Components","level":"4.2","depth":1,"next":{"title":"Extending Java Components","level":"4.2.1","depth":2,"anchor":"#extending-java-component","path":"advanced/extending-components.md","ref":"advanced/extending-components.md#extending-java-component","articles":[]},"previous":{"title":"Using our Java Components in JS","level":"4.1.2","depth":2,"anchor":"#using-java-components-in-js","path":"advanced/integrating-with-js-components.md","ref":"advanced/integrating-with-js-components.md#using-java-components-in-js","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["include","toggle-chapters"],"pluginsConfig":{"include":{},"toggle-chapters":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"advanced/extending-components.md","mtime":"2017-09-06T12:54:35.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-09-07T09:38:34.549Z"},"basePath":"..","book":{"language":""}});
10051005
});
10061006
</script>
10071007
</div>

docs/advanced/integrating-with-js-components.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -975,7 +975,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
975975
<script>
976976
var gitbook = gitbook || [];
977977
gitbook.push(function() {
978-
gitbook.page.hasChanged({"page":{"title":"Integrating With JS Components","level":"4.1","depth":1,"next":{"title":"Using JS Components in Java","level":"4.1.1","depth":2,"anchor":"#using-js-components-in-java","path":"advanced/integrating-with-js-components.md","ref":"advanced/integrating-with-js-components.md#using-js-components-in-java","articles":[]},"previous":{"title":"JsTools","level":"3.4.5","depth":2,"anchor":"#js-tools","path":"js-interop/README.md","ref":"js-interop/README.md#js-tools","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["include","toggle-chapters"],"pluginsConfig":{"include":{},"toggle-chapters":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"advanced/integrating-with-js-components.md","mtime":"2017-08-15T19:15:42.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-09-06T09:17:10.167Z"},"basePath":"..","book":{"language":""}});
978+
gitbook.page.hasChanged({"page":{"title":"Integrating With JS Components","level":"4.1","depth":1,"next":{"title":"Using JS Components in Java","level":"4.1.1","depth":2,"anchor":"#using-js-components-in-java","path":"advanced/integrating-with-js-components.md","ref":"advanced/integrating-with-js-components.md#using-js-components-in-java","articles":[]},"previous":{"title":"JsTools","level":"3.4.5","depth":2,"anchor":"#js-tools","path":"js-interop/README.md","ref":"js-interop/README.md#js-tools","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["include","toggle-chapters"],"pluginsConfig":{"include":{},"toggle-chapters":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"advanced/integrating-with-js-components.md","mtime":"2017-08-15T19:15:42.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-09-07T09:38:34.549Z"},"basePath":"..","book":{"language":""}});
979979
});
980980
</script>
981981
</div>

0 commit comments

Comments
 (0)