Skip to content

Commit

Permalink
fix(docs): markdown lint path and README fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
jankapunkt committed Jul 4, 2023
1 parent c1e6b08 commit 2747d4f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 20 deletions.
40 changes: 23 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Leaonline UI Components
# lea.online UI Components

This package brings common UI components to the Blaze ecosystem that are
[![Test suite](https://github.com/leaonline/ui/actions/workflows/node.js.yml/badge.svg)](https://github.com/leaonline/ui/actions/workflows/node.js.yml)
[![built with Meteor](https://img.shields.io/badge/Meteor-package-green?logo=meteor&logoColor=white)](https://meteor.com)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
![GitHub](https://img.shields.io/github/license/leaonline/ui)

This package brings common UI components to the Blaze ecosystem that are
required in many of the lea.online applications.

#### Components (Templates)
## Components (Templates)

- Soundbutton - A button with an associated tts-id, resolved by the TTSClient to play the associated sound
- Text - Renders a basic Text plus the associated sound button
Expand All @@ -12,21 +18,21 @@ required in many of the lea.online applications.
- Icon - wrapper for icon frameworks (currently using font-awesome 5)
- ActionButton - A button with a certain action and an integrated SoundButton

#### Renderers (Templates)
## Renderers (Templates)

All lea.online applications resolve around certain interactions, mostly them being part of several units.
In order to dynamically display (and edit) these interactions, we use a set of dynamic renderers:

| Name | key | Description |
|----------|------------|---------------------------------------------------------------------------------------------------|
| Factory | `factory` | A Blaze factory template to dynamically load and execute a renderer by given name with given data |
| Page | `page` | renders a page with mixed and variable content
| Text | `text` | renders plain text |
| Image | `image` | renders a lazy-loaded image |
| Item | `item` | render-factory for specific item types |
| Markdown | `markdown` | renders markdown, requires a custom renderer function that uses the host app's markdown parser|
| Name | key | Description |
|----------|------------|--------------------------------------------------------------------------------------------|
| Factory | `factory` | A factory template to dynamically load and execute a renderer by given name with given data|
| Page | `page` | renders a page with mixed and variable content |
| Text | `text` | renders plain text |
| Image | `image` | renders a lazy-loaded image |
| Item | `item` | render-factory for specific item types |
| Markdown | `markdown` | renders markdown, requires a custom renderer function using the host app's markdown parser |

**Init task renderers**
### Init task renderers

Initializing renderer allows to pass options by using their key
and pass options as Object:
Expand All @@ -51,8 +57,8 @@ TaskRenderers.init({
We use a proxy project for testing. Please follow the steps for setup and run:

```bash
$ cd test-proxy
$ meteor npm install
$ meteor npm run setup
$ meteor npm run test:watch
cd test-proxy
meteor npm install
meteor npm run setup
meteor npm run test:watch
```
6 changes: 3 additions & 3 deletions test-proxy/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
"setup": "mkdir -p packages && ln -sfn ../../ ./packages/ui",
"lint:code": "npm run setup && standardx -v ../ | snazzy",
"lint:code-fix": "npm run setup && standardx --fix ../ | snazzy",
"lint:markdown": "markdownlint \"./packages/corelib/**/*.md\" --config ./.markdownlint.json",
"lint:markdown-fix": "markdownlint --fix \"./packages/corelib/**/*.md\" --config ./.markdownlint.json",
"lint:markdown": "markdownlint \"./packages/ui/**/*.md\" --config ./.markdownlint.json",
"lint:markdown-fix": "markdownlint --fix \"./packages/ui/**/*.md\" --config ./.markdownlint.json",
"test": "METEOR_PACKAGE_DIRS='../../' TEST_BROWSER_DRIVER=puppeteer meteor test-packages --once --extra-packages jkuester:http --driver-package meteortesting:mocha ../ --port=6776",
"test:watch": "METEOR_PACKAGE_DIRS='../../' TEST_BROWSER_DRIVER=puppeteer TEST_WATCH=1 meteor test-packages --extra-packages jkuester:http --driver-package meteortesting:mocha ../ --port=6776",
"test:coverage": "meteor npm run setup && METEOR_PACKAGE_DIRS='../../' TEST_BROWSER_DRIVER=puppeteer COVERAGE=1 COVERAGE_OUT_HTML=1 COVERAGE_OUT_LCOVONLY=1 COVERAGE_APP_FOLDER=$(pwd)/ meteor test-packages --once --driver-package meteortesting:mocha --extra-packages jkuester:http,lmieulet:meteor-legacy-coverage,lmieulet:meteor-coverage $(pwd)/packages/corelib --port=6776"
"test:coverage": "meteor npm run setup && METEOR_PACKAGE_DIRS='../../' TEST_BROWSER_DRIVER=puppeteer COVERAGE=1 COVERAGE_OUT_HTML=1 COVERAGE_OUT_LCOVONLY=1 COVERAGE_APP_FOLDER=$(pwd)/ meteor test-packages --once --driver-package meteortesting:mocha --extra-packages jkuester:http,lmieulet:meteor-legacy-coverage,lmieulet:meteor-coverage $(pwd)/packages/ui --port=6776"
},
"dependencies": {
"@babel/runtime": "^7.11.2",
Expand Down

0 comments on commit 2747d4f

Please sign in to comment.