Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shazron/cc-libraries-api
https://github.com/shazron/cc-libraries-api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/shazron/cc-libraries-api
- Owner: shazron
- License: apache-2.0
- Fork: true (AdobeDocs/cc-libraries-api)
- Created: 2020-10-07T01:23:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T06:16:07.000Z (4 months ago)
- Last Synced: 2024-08-21T07:38:04.906Z (4 months ago)
- Language: JavaScript
- Size: 30 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Adobe I/O Documentation Template
This is a site template built with the [Adobe I/O Theme](https://github.com/adobe/aio-theme).
View the [demo](https://adobedocs.github.io/dev-site-documentation-template/) running on Github Pages.
## Where to ask for help
The slack channel #adobeio-onsite-onboarding is our main point of contact for help. Feel free to join the channel and ask any questions.
## How to develop
For local development, simply use :
```shell
$ yarn install
$ yarn dev
```
For the developer documentation, read the following sections on how to:
- [Arrange the structure content of your docs](https://github.com/adobe/aio-theme#content-structure)
- [Link to pages](https://github.com/adobe/aio-theme#links)
- [Use assets](https://github.com/adobe/aio-theme#assets)
- [Set global Navigation](https://github.com/adobe/aio-theme#global-navigation)
- [Set side navigation](https://github.com/adobe/aio-theme#side-navigation)
- [Use content blocks](https://github.com/adobe/aio-theme#jsx-blocks)
- [Use Markdown](https://github.com/adobe/aio-theme#writing-enhanced-markdown)
For more in-depth [instructions](https://github.com/adobe/aio-theme#getting-started).
## How to test
- To run the configured linters locally (requires [Docker](https://www.docker.com/)):
```shell
yarn lint
```
> NOTE If you cannot use Docker, you can install the linters separately. In `.github/super-linter.env`, see which linters are enabled, and find the tools being used for linting in [Supported Linters](https://github.com/github/super-linter#supported-linters).
- To check internal links locally
```shell
yarn test:links
```
- To build and preview locally:
```shell
yarn start
```
## How to deploy
For any team that wishes to deploy to the developer.adobe.com and developer-stage.adobe.com websites, they must be in contact with the dev-site team. Teams will be given a path that will follow the pattern `developer.adobe.com/{product}/`. This will allow doc developers to setup their subpaths to look something like:
```text
developer.adobe.com/{product}/docs
developer.adobe.com/{product}/community
developer.adobe.com/{product}/community/code_of_conduct
developer.adobe.com/{product}/community/contribute
```
### Launching a deploy
You can deploy using the GitHub actions deploy workflow see [deploy instructions](https://github.com/adobe/aio-theme#deploy-to-azure-storage-static-websites).