Skip to content

The documentation website generator

Notifications You must be signed in to change notification settings

notificationapi-com/docs

Repository files navigation

NotificationAPI

Documentation

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.

Contributing

  1. Clone the repository Clone the repo to your local machine:
    git clone https://github.com/notificationapi-com/docs.git

  2. Navigate into the project directory and install the necessary dependencies:
    cd docs
    npm install --force

  3. Create a new branch before starting your changes:
    git checkout -b feature/my-feature
    

  4. Start the local development server to preview your changes:
    npm run start
    This will launch the website locally and allow you to see your changes in real-time.
  5. Commit Your changes once you’ve completed your work:
    git add .
    git commit -m "Title" -m "Description of the changes"

  6. Push your branch:
    git push origin feature/my-feature

  7. Submit a pull request. Provide a clear description of your changes and link any related issues.

About

The documentation website generator

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published