Skip to content

Latest commit

 

History

History
112 lines (71 loc) · 3.25 KB

README.md

File metadata and controls

112 lines (71 loc) · 3.25 KB

Momonote


Pull Requests welcome

Table of Contents

About

Clean class notes to share with friends

Built With

This project was built with Vitepress, NodeJS, and NPM. it takes .md files and makes them into websites. this makes user contribution that much easier!

Getting Started

If you just want to visit the website click this link: https://momonote.mobi/ if you want to contribute head to Contributing

Prerequisites

The preqs for this project to work on it locally is to have NodeJS, NPM, and Vitepress additionaly if someone made a fork, and opened a codespace, it would have all the dependencies it would need for contribution!

Installation

To install everything that you need locally run these commands (Linux)

git clone https://github.com/mobibyte/momonote

Install NodeJS from here

sudo apt update && upgrade
sudo apt install nodejs
sudo apt install npm
npm install -g vitepress

Usage

To get started using the website follow the link here

Roadmap

See the open issues for a list of proposed features (and known issues).

Support

Reach out to the maintainer at one of the following places:

Project assistance

If you want to say thank you or/and support active development of CSECNote:

Together, we can make MOMONote better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by Diego Vester.

For a full list of all authors and contributors, see the contributors page.

Acknowledgements

(Betim): Thanks MOBI for letting me do this cool project, i hope more and more people contribute to it every day!