An open API service indexing awesome lists of open source software.

https://github.com/autodesk-platform-services/aps-tutorials-website

APS Tutorials: Docusaurus project for the APS Tutorials Website.
https://github.com/autodesk-platform-services/aps-tutorials-website

documentation docusaurus react tutorial

Last synced: 9 months ago
JSON representation

APS Tutorials: Docusaurus project for the APS Tutorials Website.

Awesome Lists containing this project

README

          

# APS Tutorials Website

Source code and content for the tutorials website https://aps.autodesk.com/tutorials. Built using [Docusaurus 2](https://docusaurus.io/).

## Development

### Installation

```
$ npm install
```

### Local Debugging

```
$ npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

> Note: if you need to debug something using the default navbar (for example, to get access to the language dropdown), you can temporarily toggle the `themeConfig.useDefaultNavbar` value in _docusaurus.config.js_.

### Build

```
$ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

The `master` branch is automatically deployed to GitHub Pages (see [deploy.yml](.github/workflows/deploy.yml)). The content is then accessible via the https://tutorials.autodesk.io domain.

## Contributing

Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) for additional information around authoring new content.

## Troubleshooting

Submit your question via [APS Support Form](https://aps.autodesk.com/en/support/get-help).

## License

This code is licensed under the terms of the [MIT License](http://opensource.org/licenses/MIT). Please see the [LICENSE](LICENSE) file for more details.