This directory contains all the documents pertaining to the use of astro-xelement
The directory is setup to provide easier access to information that the user might need when using this XElement.
Here you can view the raw resources and content that powers our documentation site, located in www/xelement.
The Documentation for astro-xelement is set out in the following manner:
Every project has its own unique way of introducing new developers to their creations. For XElement it is no different. We wish for you to be suitably brought up to speed with our product.
Our short induction guides to XElement is enough to get you up and going with alot of the core concepts of XElement and how to go about utilizing the power that it provides fellow Astronauts when authoring in Astro.
The api/ directory is XElement's main reference repository. Here you will find all the technical writings, information and more detailed code explanations for each of XElements methods and behaviors.
If you have any issues or require additional support when utilizing XElement, it is here within the api/ directory you should be able find your answers.
The guides/ directory is where we wish to provide you with supportive literature that would be able to help you get quickly up to speed with using XElement.
Creating components in Astro can be either daunting or exceedingly easy, and that depends on many factors. Our guides would help you expand your ability to write good Astro.
XElement aside, the methods we used can be used outwith XElement when it comes to writing Astro components and our examples would be in JavaScript, utilizing only standard and conventional methods that you will be able to find practiced elsewhere.
Where the informal and the verbose is given space. Technical documentation is in respects aimed at providing a tasteless experience when you are consuming them. We feel that there is also space for more informal, less beige style of writing that could help explain XElement to others in a different light.
This also gives us a slightly different platform to be able to discuss further developments and all things XElement, outwith the scope of the technical literature found elsewhere in these docs.
These documents are a living form. They will change and content will grow over time. As much as this endeavour would be pushed by the authors and interested parties of the project.
It would be always be pleasure of ours to help receive content and be able to assist other users of XElement into contributing to the project.
XElement is more of a gift to other Astronauts, and as with gifts, there is no expected return, we just hope that you enjoy using XElement within your Astro projects, and we would be delighted to here of your stories and see your creations in the wild, so please do share them with us, via our Github.