File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -9,6 +9,13 @@ explore learning pathways. It is developed by
99- ** Repository:** https://github.com/openpath/learningmap
1010- ** Community** : https://matrix.to/#/#openpatch:matrix.org
1111
12+ ## Platforms
13+
14+ - ** Web App** : Create and share learningmaps at [ learningmap.app] ( https://learningmap.app )
15+ - ** VS Code Extension** : Edit ` .learningmap ` files locally in VS Code (see [ platforms/vscode] ( platforms/vscode ) )
16+ - ** React Component** : Integrate learningmap into your own React app (see [ packages/learningmap] ( packages/learningmap ) )
17+ - ** Web Component** : Use learningmap in any web application (see [ packages/web-component] ( packages/web-component ) )
18+
1219## Documentation
1320
1421If you want to work on the documentation, run the
Original file line number Diff line number Diff line change @@ -40,7 +40,8 @@ learningmap/
4040│ ├── learningmap/ # Core React component library
4141│ └── web-component/ # Web component wrapper
4242├── platforms/
43- │ └── web/ # Web application (learningmap.app)
43+ │ ├── web/ # Web application (learningmap.app)
44+ │ └── vscode/ # VS Code extension
4445├── docs/ # Documentation (Hyperbook)
4546└── scripts/ # Build and development scripts
4647```
@@ -88,6 +89,23 @@ pnpm docs:dev
8889
8990The documentation is built with [ Hyperbook] ( https://hyperbook.openpatch.org ) and is located in the ` docs/ ` directory.
9091
92+ ### VS Code Extension
93+
94+ To develop the VS Code extension:
95+
96+ 1 . Build the extension:
97+ ``` bash
98+ pnpm --filter learningmap-vscode build
99+ ```
100+
101+ 2 . Open the ` platforms/vscode ` directory in VS Code
102+
103+ 3 . Press F5 to launch the Extension Development Host
104+
105+ 4 . Open or create a ` .learningmap ` file to test the editor
106+
107+ See [ platforms/vscode/DEVELOPMENT.md] ( ../../platforms/vscode/DEVELOPMENT.md ) for more details.
108+
91109## Testing Your Changes
92110
931111 . ** Type-check** : ` pnpm lint `
You can’t perform that action at this time.
0 commit comments