Welcome to the cardano.org website. We believe that this website should be managed by a collective and not a single entity. For this to be successful, the website relies on your contributions.
cardano.org follows an incremental evolution model. This repository avoids full rebuild projects, agency-led redesigns, or “start from scratch” initiatives unless there is a demonstrated, documented and reviewed technical need. Improvements should be made through small, reviewable, continuously shipped changes.
Suitable contributions include:
- Content fixes, clarity, translations (once established), link hygiene.
- UI/UX improvements that follow existing design tokens.
- Component or navigation improvements backed by discussion.
- Docs, accessibility, performance and “paper cut” improvements.
Not suitable (without prior discussion):
- Visual redesigns, rebranding, theme changes
- Moving to a new framework or build system
- Agency-style proposals for large paid revamps
- Large content reshuffles without information architecture discussion
- Comment “I’d like to work on this”
- Wait for maintainer assignment
- If inactive for 21 days, issue becomes unassigned
- CONTRIBUTING.md
- CODE_OF_CONDUCT.md
- docs/ for content
- Dicussions for idea-level conversations
This website is built using Docusaurus, a modern static website generator. This will get you up and running:
Node.js version >= 18.0
Yarn version >= 1.22
On macOS you also need Xcode and Command Line Tools.
git clone https://github.com/cardano-foundation/cardano-org.git
cd cardano-org
yarn install
yarn start
This command starts a local development server and opens up a browser window to http://localhost:3000. Most changes are reflected live without having to restart the server.
To browse the documentation visit http://localhost:3000/docs/.
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service. Always build the site once before firing a pull request as many additional checks are carried out.
yarn start --host 0.0.0.0
With this command you are making it listen on all network interfaces (IP addresses) of your computer. This includes the local loopback interface (127.0.0.1 or localhost) and any other network interfaces that can connect your computer to a local network or the internet. Great for testing the site with different devices on your local network.