Developer Site
Developer resources website for PlayCanvas
Overview
The PlayCanvas Developer Site serves as a comprehensive resource for developers looking to leverage the capabilities of the PlayCanvas engine. This platform is built efficiently using static web content that is dynamically generated from Markdown files with the help of Docusaurus. Whether you’re a seasoned developer or new to the space, this site offers a robust framework for accessing tutorials, FAQs, and localization options that enhance the development experience.
Building and serving the site is straightforward, thanks to the requirements of Node.js 18+ and an intuitive command structure. With features focused on iterative development, users can quickly make changes and observe them in real-time, ensuring that the most up-to-date content is always available.
Features
-
Easy Setup: Requires only Node.js 18+ for building the site, making it accessible for most developers.
-
Local Development: The built site can be served locally, allowing developers to view changes in real-time as they work on the site.
-
Quick Iteration: The 'start' command enables automatic rebuilding of the site whenever changes occur in tutorial or static content.
-
Markdown Tutorials: Tutorials are created and edited as Markdown files, simplifying content creation and updates.
-
Localized Support: The use of AI-powered translation facilitates localization, ensuring that the site is also accessible in Japanese.
-
Community Collaboration: Contributions via pull requests are encouraged for translation improvements, fostering a collaborative environment for documentation enhancement.
- Docusaurus
Docusaurus is an open-source static site generator designed for creating documentation websites. Developed by Facebook, it simplifies the process of building, deploying, and maintaining documentation with its React-based framework and pre-configured setup for documentation projects.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
