@dhimath/studio
v0.1.38
Published
A platform for creating and hosting interactive, online courses.
Downloads
2
Readme
Dhimath Studio
Welcome to Dhimath Studio. This is a fork of Mathigon Studio with some fixes and improvements.
Usage
This repository is not intended to be used standalone. You will need to create a parent repository
containing the content, settings, and any customisations for this course. You can see a sample
repository at docs/example. Then install Dhimath Studio as a dependency using
npm install @dhimath/studio
.
For more details on how to set up a server, customise its settings, and create interactive courses, take a look at our documentation:
Directory Structure
Here is a breakdown of all the components included in this repository:
- build/: Build tools like a custom markdown parser and JS/CSS asset bundling.
- docs/: Documentation and a sample implementation
- frontend/: Client-side TypeScript code and
SCSS styles. Ever top-level
.ts
or.scss
file in this directory will get bundled into a separate.js
or.css
file in thepublic
directory. - server/: A NodeJS Express application for serving the course website.
- tests/: Markdown compiler tests and screenshot generation.
- translations/: Translations for all built-in strings.
Contributing
We welcome any contributions to Dhimath Studio: from bug fixes to writing more documentations, adding new translations, or developing entirely new features. If you find any bugs or errors, please file an issue.