ORAS Documentation
Source for ORAS website and documentation
This website is built using Docusaurus 2. Pages and components are built in JavaScript, and styles are written in vanilla CSS.
Development
Online one-click setup
You can use Gitpod (a free, online, VS Code-like IDE) for contributing. With a single click, it will launch a workspace (for Docusaurus 2) automatically:
- clone the docusaurus repo.
- install the dependencies.
- run
npm start
So that you can start contributing straight away.
System Requirements
- Node.js v16.x and above
Installation
npm install
Local development
npm run start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. The site will be available at http://localhost:3000/
Build for production
npm run build
This command generates static content into the build directory and can be
served using any static contents hosting service. For that purpose, you can also
use:
npm run serve
Code of Conduct
This project has adopted the CNCF Code of Conduct. See CODE_OF_CONDUCT.md for further details.
Contributions
Thank you for considering to contribute to the project, We appreciate your time and effort. Checkout the Contribution Guide to know more about contributing.