notations 0.0.67 → 0.0.69

package/README.md

@@ -1,42 +1,72 @@
-
 # Notations
 
-Notations is a Typescript library for rendering Carnatic music.  Notations comes with:
+A TypeScript library for parsing, modeling, and rendering Carnatic music notation.
 
-1. An API for representing and rendering carnatic music.
-2. A DSL and an accompanying parser for representing music in a simpler and intuitive way.
+**[Live Demo](https://notations.us)** | **[Documentation](https://panyam.github.io/notations/)**
 
-## Documentation
+## Features
 
-📚 **[Full Documentation](https://panyam.github.io/notations/)** - Tutorials, API reference, cookbook examples, and more.
+- **DSL Parser** - Intuitive text-based notation format
+- **Flexible Rendering** - SVG-based output with CSS theming
+- **Framework Agnostic** - Works with React, Vue, vanilla JS, or any framework
+- **Light/Dark Mode** - Built-in theme support via CSS variables
 
-# Getting Started
+## Quick Start
 
-## Installation
+### Via CDN (no build tools required)
 
-```
-# Install Typescript
-npm i typescript
+```html
+<link rel="stylesheet" href="https://unpkg.com/notations/dist/NotationView.min.css">
+<script src="https://unpkg.com/notations/dist/notations.umd.min.js"></script>
 
-# Install the library (in a folder that already contains your package.json file).
-npm install --save notations
+<script>
+  const source = `
+\\cycle("|4|2|2|")
+Sw: S R G M P D N S.
+  `;
 
+  const container = document.getElementById('notation');
+  const [notation, beatLayout, errors] = Notations.load(source);
+
+  if (errors.length === 0) {
+    const view = new Notations.Carnatic.NotationView(container);
+    view.renderNotation(notation, beatLayout);
+  }
+</script>
 ```
 
-## Example
+### Via npm/pnpm
 
+```bash
+npm install notations
 ```
-import { NotationView } from notations;
-
-const element = document.getElementById("mydiv");
-const notationView = new NotationView(element);
-notationView.add(new Note("Ga"), new Space(),
-                 new Note("Ga"), new Space(),
-                 new Note("Ri"), new Space(),
-                 new Note("Ri"), new Space(),
-                 new Note("Sa"), new Note("Sa"), 
-                 new Note("Ri"), new Note("Ri"), 
-                 new Note("Ga"), new Note("Ga"), 
-                 new Note("Ri"), new Note("Ri"));
+
+```typescript
+import * as N from 'notations';
+import 'notations/dist/NotationView.css';
+
+const source = `
+\\cycle("|4|2|2|")
+Sw: S R G M P D N S.
+`;
+
+const [notation, beatLayout, errors] = N.load(source);
+
+if (errors.length === 0) {
+  const container = document.getElementById('notation');
+  const view = new N.Carnatic.NotationView(container);
+  view.renderNotation(notation, beatLayout);
+}
 ```
 
+## Documentation
+
+- **[Getting Started](https://panyam.github.io/notations/getting-started/)** - Installation and setup
+- **[Tutorials](https://panyam.github.io/notations/tutorials/)** - Learn the notation syntax
+- **[API Reference](https://panyam.github.io/notations/api/)** - Full API documentation
+- **[Integration Guide](https://panyam.github.io/notations/api/integration-guide/)** - React, Vue, Node.js integration
+- **[Styling & Theming](https://panyam.github.io/notations/api/styling/)** - Customize appearance with CSS variables
+
+## License
+
+ISC

package/dist/NotationView.css

@@ -0,0 +1,107 @@
+/* ========================================
+   CSS Custom Properties (Theme Variables)
+   ======================================== */
+:root {
+  /* Colors */
+  --notation-stroke-color: black;
+  --notation-fill-color: transparent;
+  --notation-text-color: #1a1a1a;
+  --notation-border-color: gray;
+  /* Strokes */
+  --notation-stroke-width: 1;
+  --notation-bar-line-width: 1;
+  /* Spacing (can be overridden) */
+  --notation-line-padding: 5px;
+  --notation-annotation-padding: 10px;
+}
+
+/* Dark mode */
+:root.dark,
+[data-theme=dark] {
+  --notation-stroke-color: #e5e5e5;
+  --notation-fill-color: transparent;
+  --notation-text-color: #f0f0f0;
+  --notation-border-color: #555;
+}
+
+/* System preference fallback */
+@media (prefers-color-scheme: dark) {
+  :root:not(.light):not([data-theme=light]) {
+    --notation-stroke-color: #e5e5e5;
+    --notation-fill-color: transparent;
+    --notation-text-color: #f0f0f0;
+    --notation-border-color: #555;
+  }
+}
+/* ========================================
+   SVG Element Styles
+   ======================================== */
+/* Octave indicator dots */
+.notation-octave-dot {
+  stroke: var(--notation-stroke-color);
+  stroke-width: var(--notation-stroke-width);
+}
+
+/* Bar lines (start and end) */
+.bar-start-line,
+.bar-end-line {
+  stroke: var(--notation-stroke-color);
+  stroke-width: var(--notation-bar-line-width);
+}
+
+/* Jaaru (glide) paths */
+.notation-jaaru-path {
+  stroke: var(--notation-stroke-color);
+  fill: var(--notation-fill-color);
+}
+
+/* Text elements - target all SVG text within notation */
+.notationsContentRootTable text,
+.atomViewTextRoot,
+.notation-embelishment-label {
+  fill: var(--notation-text-color);
+}
+
+/* HTML text elements (metadata, headings, markdown content) */
+.notationsContentRootTable,
+.rawBlockContentCell,
+.rawBlockContentCell * {
+  color: var(--notation-text-color);
+}
+
+/* ========================================
+   Layout Styles
+   ======================================== */
+.lineRow {
+  border: none;
+}
+
+.lineAnnotationCell {
+  padding: 0px;
+  padding-left: 10px;
+  padding-right: 10px;
+  padding-top: 10px;
+  vertical-align: top;
+}
+
+.lineContentCell {
+  padding: 0px;
+  padding-top: 5px;
+  padding-bottom: 5px;
+}
+
+.rawBlockRow {
+  border: none;
+}
+
+.rawBlockContentCell {
+  padding-top: 5px;
+  padding-bottom: 5px;
+}
+
+.notationsContentRootTable {
+  border-top: solid 1px var(--notation-border-color);
+  width: 100%;
+}
+
+/*# sourceMappingURL=NotationView.css.map */

package/dist/NotationView.css.map

@@ -0,0 +1 @@
+{"version":3,"sourceRoot":"","sources":["../styles/NotationView.scss"],"names":[],"mappings":"AAAA;AAAA;AAAA;AAIA;AACE;EACA;EACA;EACA;EACA;AAEA;EACA;EACA;AAEA;EACA;EACA;;;AAGF;AACA;AAAA;EAEE;EACA;EACA;EACA;;;AAGF;AACA;EACE;IACE;IACA;IACA;IACA;;;AAIJ;AAAA;AAAA;AAIA;AACA;EACE;EACA;;;AAGF;AACA;AAAA;EAEE;EACA;;;AAGF;AACA;EACE;EACA;;;AAGF;AACA;AAAA;AAAA;EAGE;;;AAGF;AACA;AAAA;AAAA;EAGE;;;AAGF;AAAA;AAAA;AAIA;EACE;;;AAGF;EACE;EACA;EACA;EACA;EACA;;;AAGF;EACE;EACA;EACA;;;AAIF;EACE;;;AAGF;EACE;EACA;;;AAMF;EACE;EACA","file":"NotationView.css"}

package/dist/NotationView.min.css

@@ -0,0 +1 @@
+:root{--notation-stroke-color: black;--notation-fill-color: transparent;--notation-text-color: #1a1a1a;--notation-border-color: gray;--notation-stroke-width: 1;--notation-bar-line-width: 1;--notation-line-padding: 5px;--notation-annotation-padding: 10px}:root.dark,[data-theme=dark]{--notation-stroke-color: #e5e5e5;--notation-fill-color: transparent;--notation-text-color: #f0f0f0;--notation-border-color: #555}@media(prefers-color-scheme: dark){:root:not(.light):not([data-theme=light]){--notation-stroke-color: #e5e5e5;--notation-fill-color: transparent;--notation-text-color: #f0f0f0;--notation-border-color: #555}}.notation-octave-dot{stroke:var(--notation-stroke-color);stroke-width:var(--notation-stroke-width)}.bar-start-line,.bar-end-line{stroke:var(--notation-stroke-color);stroke-width:var(--notation-bar-line-width)}.notation-jaaru-path{stroke:var(--notation-stroke-color);fill:var(--notation-fill-color)}.notationsContentRootTable text,.atomViewTextRoot,.notation-embelishment-label{fill:var(--notation-text-color)}.notationsContentRootTable,.rawBlockContentCell,.rawBlockContentCell *{color:var(--notation-text-color)}.lineRow{border:none}.lineAnnotationCell{padding:0px;padding-left:10px;padding-right:10px;padding-top:10px;vertical-align:top}.lineContentCell{padding:0px;padding-top:5px;padding-bottom:5px}.rawBlockRow{border:none}.rawBlockContentCell{padding-top:5px;padding-bottom:5px}.notationsContentRootTable{border-top:solid 1px var(--notation-border-color);width:100%}/*# sourceMappingURL=NotationView.min.css.map */

package/dist/NotationView.min.css.map

@@ -0,0 +1 @@
+{"version":3,"sourceRoot":"","sources":["../styles/NotationView.scss"],"names":[],"mappings":"AAIA,MAEE,+BACA,mCACA,+BACA,8BAGA,2BACA,6BAGA,6BACA,oCAIF,6BAEE,iCACA,mCACA,+BACA,8BAIF,mCACE,0CACE,iCACA,mCACA,+BACA,+BASJ,qBACE,oCACA,0CAIF,8BAEE,oCACA,4CAIF,qBACE,oCACA,gCAIF,+EAGE,gCAIF,uEAGE,iCAOF,SACE,YAGF,oBACE,YACA,kBACA,mBACA,iBACA,mBAGF,iBACE,YACA,gBACA,mBAIF,aACE,YAGF,qBACE,gBACA,mBAMF,2BACE,kDACA","file":"NotationView.min.css"}