We are currently using Docusaurus v3.5.2, a modern static website generator for building our documentation website. For more information on Docusaurus, visit their official website.
- Clone the repository
Clone the repo to your local machine:
git clone https://github.com/notificationapi-com/docs.git
- Navigate into the project directory and install the necessary dependencies:
cd docs npm install --force
- Create a new branch before starting your changes:
git checkout -b feature/my-feature
- Start the local development server to preview your changes:
This will launch the website locally and allow you to see your changes in real-time.
npm run start
- Commit Your changes once you’ve completed your work:
git add . git commit -m "Title" -m "Description of the changes"
- Push your branch:
git push origin feature/my-feature
- Submit a pull request. Provide a clear description of your changes and link any related issues.