(WORKING IN PROGRESS)
An Alternative Documentation of Quasar Framework.
The proposal of this project is to join in one place, everything of the Quasar Documentation: the theoretical part (quasar-framework.org), showcases (Quasar Play), showcases source codes (from github) and changelogs.
You can clone this repository, run on a web server and have access to everything from the Quasar Framework completely offline on your computer! You can also compile for mobile and desktop devices.
In addition, we have created many features that make it easy to study and search for specific information within the Quasar Documentation++.
Some features of this documentation are listed below! See the projects tab for more details!
Internationalization with i18n
We want the documentation to be available in any language so that it can reach everyone.
Currently available in 2 languages: English (en) and Portuguese (pt).
Menu search engine based in keywords and i18n (Beta)
The search for content in the documentation is simple, fast and easy. The search input text in the menu makes it easy to search for any content using keywords and you can do it in your favorite language. If the defined language is not English and if the search term is not found or has not been set in current language, by default a search is still performed using keywords in English.
Documentation codes in local files (WIP)
This documentation uses the same syntax code highlight than Github and the code is inserted into the templates of the documentation pages using
<tr> tags for each line of code with the Vue
v-pre directive (when necessary). So you can access the codes of the documentation offline and we can also use i18n for example to translate code comments, insert headers with anchors, etc.
Navigation using anchored links (RC)
Anchor links work in hash and history mode and provide faster navigation and better orientation when navigating through subsections of documentation.
Partial Code View in the Showcase (TODO)
Component Builder with Source Code Output (TODO)
Wait for the CONTRIBUTING.md file to initiate a contribution to this repository.
Copyright (c) 2018-Present - Rodrigo Vieira (Slowaways)