Welcome to the repository for ojosproject.org, Ojos Project's home on the Internet! This contains the source code for our website.
Our website is built using Docusaurus, the documentation website builder.
Thanks to Docusaurus, we use three of its features on our website:
- Blogging, which is displayed on the
/news/path - Documentation, which is
displayed on the
/docs/path - Any other pages we'd want to create using React
If you'd like to make changes to the website, you can! First, you must install pnpm. Then run:
pnpm env use --global vv22.3.0
pnpm iThere's four useful commands Docusaurus provides:
| Command | Description |
|---|---|
pnpm start |
Starts the website in development mode |
pnpm clear |
Is something not working? This clears the cache! |
pnpm build |
Makes a production-ready version of the website |
pnpm serve |
Starts the website in production mode |
Tip
If you're having issues with Docusaurus, clearing the cache with
pnpm clear may help.
Before pushing, I recommend running
pnpm clear; pnpm build; pnpm serve, which runs the three commands in
that order to make sure you don't have any remaining bugs.
You can contribute by opening an Issue (after, of course, checking if the same issue doesn't already exist) or providing code.
Please don't use the main branch. It must always be stable and will only be
merged into. Please create a branch named issue-x, where x is the issue number
this branch is for. Then submit a PR.
Carlos Valdez is the maintainer of the website repository. The website is being maintained by open source contributors at Ojos Project.