Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tidev/docs-devkit
Tooling for Axway Appcelerator open source documentation. https://titanium-docs-devkit.netlify.com/
https://github.com/tidev/docs-devkit
npm-package
Last synced: 3 months ago
JSON representation
Tooling for Axway Appcelerator open source documentation. https://titanium-docs-devkit.netlify.com/
- Host: GitHub
- URL: https://github.com/tidev/docs-devkit
- Owner: tidev
- Created: 2019-02-28T01:57:37.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-03-21T17:55:33.000Z (11 months ago)
- Last Synced: 2024-10-31T12:39:40.297Z (4 months ago)
- Topics: npm-package
- Language: JavaScript
- Homepage:
- Size: 11.4 MB
- Stars: 24
- Watchers: 17
- Forks: 18
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# docs-devkit
> Tooling for Axway Appcelerator open source documentation
[](https://app.netlify.com/sites/titanium-docs-devkit/deploys)
This is the home for all the libraries, plugins and themes to build sleek and modern documentations using VuePress.
📖 View the [Documentation](https://titanium-docs-devkit.netlify.com/).
## Packages
This is a monorepo with the following packages:
| Package | Description | Version | Links |
|---|---|---|---|
| titanium-docgen | Various generators to format Titanium API documentation | [](https://www.npmjs.com/package/titanium-docgen) | [](packages/titanium-docgen#readme) |
| vuepress-plugin-apidocs | Plugin for VuePress to render API reference documentation | [](https://www.npmjs.com/package/vuepress-plugin-apidocs) | [](packages/vuepress/vuepress-plugin-apidocs#readme) |
| vuepress-plugin-versioning | Versioning plugin for VuePress | [](https://www.npmjs.com/package/vuepress-plugin-versioning) | [](packages/vuepress/vuepress-plugin-versioning#readme) |
| vuepress-theme-titanium | VuePress theme for Titanium projects | [](https://www.npmjs.com/package/vuepress-theme-titanium) | [](packages/vuepress/vuepress-theme-titanium#readme) |
## Contributing
Open source contributions are greatly appreciated! If you have a bugfix, improvement or new feature, please create
[an issue](https://github.com/appcelerator/docs-devkit/issues/new) first and submit a [pull request](https://github.com/appcelerator/docs-devkit/pulls/new) against master.
Before you contribute read through the following guidelines.
* The `master` branch contains a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch.**
* Checkout relevant topic branches, e.g. `develop` and merge back against that branch.
* Your commit messages should follow the [Conventional Commits Specification](https://conventionalcommits.org/) so that changelogs and version bumps can be automatically generated. If you are not familiar with the commit message convention, you can use `npm run commit` instead of git commit, which provides an interactive CLI for generating proper commit messages.
* We will let GitHub automatically squash your PR before merging, so don't worry about making multiple small commits.
## Getting Help
If you have questions about our documentation devkit for VuePress, feel free to reach out on Stackoverflow or the
`#helpme` channel on [TiSlack](http://tislack.org). In case you find a bug, create a [new issue](https://github.com/appcelerator/docs-devkit/issues/new)
or open a [new JIRA ticket](https://jira.appcelerator.org).
## License
Apache License. Version 2.0