{"repo":"tidev/titanium-docs","free":true,"listed":false,"github":"https://github.com/tidev/titanium-docs","clone":"git clone https://github.com/tidev/titanium-docs.git","description":"We use VuePress for Guides and API docs.","language":"JavaScript","stars":14,"topics":["hacktoberfest","vuepress","documentation","vue","markdown"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"titanium-docs Website with Guides and API docs for the Titanium SDK (Powered by VuePress). Getting started These docs aim to be a hybrid solution of Markdown bases guides and dynamically generated docs for API references using the existing apidoc from Titanium. Installation Development VuePress supports a dev mode with hot reloading for a convenient developing experience. Now start editing the docs and you can immediatly see the results in your browser. Building the docs There are currently a few manual steps required to build the docs which we aim to consolidate into a single build step while this project moves foreward. ✅ For convenience the repo currently contains a pre-generate api.json so you can skip this if you just want to play with the new docs. The following steps assume you have checked out this repo parallel to Titanium so that your folder structure looks like this: Now generate the api.json into the docs/api folder Finally, let VuePress build the awesome new docs. This will output the statically rendered docs into docs/.vuepress/dist . Versioning Run the script with a command line argument of the version you wish to create. e.g., This will preserve all documents currently in the docs directory and make them available as documentation for version 8.0 . For more info please refer to the versioning guide. Migrating docs to VuePress VuePress renders gorgeously looking documentation directly from markdown files. This means that our currents guides and parts of the api","default_branch":null,"files":null,"tree":[],"storefront":"/r/tidev","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/tidev/titanium-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}