Table of Contents
This is a repository to hold your notes Cybersecurity & CTF related as well!
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!
If you just want to visit the website click this link: https://csecnote.pages.dev/ if you want to contribute head to Contributing
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!
To install everything that you need locally run these commands (Linux)
git clone https://github.com/csecclub/CSECNote
Install NodeJS from here
sudo apt update && upgrade
sudo apt install nodejs
sudo apt install npm
npm install -g vitepress
This project REQUIRES npm
npm
npm run docs:dev
npm run docs:build
To get started using the website follow the link here
See the open issues for a list of proposed features (and known issues).
Reach out to the maintainer at one of the following places:
- GitHub issues
- Contact options listed on this GitHub profile
If you want to say thank you or/and support active development of CSECNote:
- Add a GitHub Star to the project.
Together, we can make CSECNote better!
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!
The original setup of this repository is by Betim Hodza.
For a full list of all authors and contributors, see the contributors page.
(Betim): Thanks CSEC for letting me do this cool project, i hope more and more people contribute to it every day!