# 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](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:

* [Setup and Customisation](docs/setup.md)
* [Course Markdown Syntax](docs/markdown.md)
* [Interactive Components](docs/interactives.md)

## Directory Structure

Here is a breakdown of all the components included in this repository:

* [__build/__](build): Build tools like a custom markdown parser and JS/CSS asset bundling.
* [__docs/__](docs): Documentation and a sample implementation
* [__frontend/__](frontend): Client-side [TypeScript](https://www.typescriptlang.org/) code and
  [SCSS](https://sass-lang.com/) styles. Ever top-level `.ts` or `.scss` file in this directory will
  get bundled into a separate `.js` or `.css` file in the `public` directory.
* [__server/__](server): A NodeJS Express application for serving the course website.
* [__tests/__](tests): Markdown compiler tests and screenshot generation.
* [__translations/__](translations): Translations for all built-in strings.

## Contributing

[![npm](https://img.shields.io/npm/v/@dhimath/studio)](https://www.npmjs.com/package/@dhimath/studio)
![GitHub repo size](https://img.shields.io/github/repo-size/dhimath/studio)
![GitHub issues](https://img.shields.io/github/issues-raw/dhimath/studio)

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](https://github.com/dhimath/studio/issues).

---

[![Twitter Follow](https://img.shields.io/twitter/follow/dhimath_india?style=social)](https://twitter.com/intent/follow?screen_name=dhimath_india)


