Shawon Notes

Shawon Notes is an open-source compiled study resource website for IGCSE and IAL students.

How to Use

Prerequisites

• Node.js version 18 or higher.
• Terminal for accessing VitePress via its command line interface (CLI).
• Text Editor with Markdown syntax support.
  • VSCode is recommended

To install the dependencies, run the following command in the terminal:

npm install

To run the local server:

npm run dev

How to Contribute

We encourage everyone to contribute to this project. There are many ways you can contribute:

• Report bugs or broken links: If you find any bugs or broken links on the website, please create an issue in the GitHub repository.
• Update revision notes: The syllabus and specifications can change over time. If you notice that any of our revision notes are outdated or could be improved, feel free to make updates and submit a pull request.
• Add past papers: If you have access to the latest unlocked past papers, you can add links to them on the website.

Syntax

This project is build on VitePress. To learn about markdown syntax please visit vitepress documentation

Contact

If you need help or have any questions about contributing, please feel free to contact me.

License

Shawon Notes is open source and available under the MIT License.