Skip to content

The Ojos Project website containing our blogs and documentation!

License

GPL-3.0, CC-BY-4.0 licenses found

Licenses found

GPL-3.0
LICENSE
CC-BY-4.0
LICENSE-CONTENT
Notifications You must be signed in to change notification settings

ojosproject/website

Repository files navigation

ojosproject.org

Description

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.

Features

Thanks to Docusaurus, we use three of its features on our website:

Getting Started

Installing dependencies

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 i

npm commands

There'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.

Contributing

You can contribute by opening an Issue (after, of course, checking if the same issue doesn't already exist) or providing code.

Working in this repository

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.

Acknowledgements

Carlos Valdez is the maintainer of the website repository. The website is being maintained by open source contributors at Ojos Project.

License

Content: Creative Commons Attribution 4.0 International

Code: GNU General Public License v3.0

About

The Ojos Project website containing our blogs and documentation!

Resources

License

GPL-3.0, CC-BY-4.0 licenses found

Licenses found

GPL-3.0
LICENSE
CC-BY-4.0
LICENSE-CONTENT

Stars

Watchers

Forks

Contributors 10