README.md

openphysicsnotes

Open Physics Notes server and content main repository.

Visit our website @ openphysicsnotes.org!

About this project

This project is aimed to provide a common way of sharing notes, lessons and exercises for physics, math or any other discipline.

Out there there are a lots of students managed shared folders with free notes, pdf and other awesome content 🤗. For example, at UniPi we have:

• studentifisicapisa.altervista.org
• Mega Folder
• other internal drives with not-so-legal content i cannot post

So we came with the idea of a unified place to share content. Not by writing separate PDFs (hard to collaborate with) but a more dynamic website so that it is easier to collaborate, create notes for a courses, make alternative note courses it you don't like the existing ones.
Also we will provide a simple Mega-like sharing system for additional content and large files so that Mega folders would not be needed anymore.

Note that this website is not a encyclopedia, use WikipediA for that. Anyway we hope to add a wikipedia style app to organize theorems and useful equations in the future!

Ideas to implement

• a web server
• (optional) a static website generator?
• a file sharing portal
• a theorems organization system
• a collaborative web app to make it easier to collaborate
• a better content organization
• write extensive guides and contributing tips
• create an awesome graphics
• use 3rd level domains for the editing app, sharing content, wiki, and other stuff
• TODO use creativecommons.org
• dark/light theme
• a two.js based or inspired graphics library that allows contributors to easily write professional drawings, with the possibility of fluid animations. (The problem is how to make intellisense work in such files for a library like this, see working with javascript)
• pyscript
• serve content using a react application instead od dynamically generated html, or use a react application in edit.openphysicsnotes.org, a VS like website that uses browser storage to make changes and push on github or any other cloud.
• raw.*.org
• drive.*.org
• raw.drive.*.org
• edit link like mdn + edit directly on github.dev
• opn preview plugin + something like .opn.config.json/yaml and relative schema
• caching
• pdf and latex exportation
• un file config.ts per fare in modo che alcune impostazioni come live reload sia abilitato solo in development; move reloader in a separate file instead of plain js inside the html
• compression
• add allowed extensions such as lcml or lcmd and add a vscode extension for a correct preview or extend default MD preview
• gfm warning (> :warning:)
• issue markdown-it-container: nested should not require different numbers of : and should ignore inside code or similar. needs a different approach for the parser
• mozzilla like demo https://developer.mozilla.org/en-US/docs/Web/HTML/Element/br?retiredLocale=it
• github action to tell the servet to "git pull"
• stackedit like app for all the students to write personal notes
• a C++ addon for the drive api, use a custom C++ implementation of the kfs that uses a monolitic file for storing edits, use a differential system and packed cache system
• Any approved accounts can upload to drive, at least one approved git contribution is needed or explicitly added by admins; ban for illicit content upload
• ToS, EUA, drive ToS, articles and drive files licenses, drive attributions, etc...
• caching system, like memoize for online server

Stuff organization

At the moment, there is only one big repository, in the future this will change and we will separate the content in one or multiple repos.

In this repo you will find:

• server/: the folder containing all the server scripts, you can use npm start to start a local preview server
• content/: the folder containing the website and notes content.

For any info on how to contribute, see contributing.md

Discussion

Please use the GiHub Discussion and use GitHub Issues to point out problems, make proposals, suggestions or request project clarifications.

---

Enjoy 😉