Skip to content

Commit 18a0457

Browse files
committed
style: re-format markdown
1 parent 8179926 commit 18a0457

File tree

3 files changed

+5
-19
lines changed

3 files changed

+5
-19
lines changed

CHANGELOG.md

-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ _Re-release of `v11.0.2`._
4747
* New popup menu UI introduced with `diagram-js@11`. See [`diagram-js` breaking changes and migration guide](https://github.com/bpmn-io/diagram-js/blob/develop/CHANGELOG.md#breaking-changes).
4848
* Keyboard-related features no longer use `KeyboardEvent#keyCode`. Use a polyfill (e.g. [keyboardevent-key-polyfill](https://www.npmjs.com/package/keyboardevent-key-polyfill)) if you need to support old browsers.
4949

50-
5150
## 10.3.0
5251

5352
* `FEAT`: add BPMN specific space tool ([#1344](https://github.com/bpmn-io/bpmn-js/pull/1344))

README.md

-8
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ View and edit BPMN 2.0 diagrams in the browser.
66

77
[![bpmn-js screencast](./resources/screencast.gif "bpmn-js in action")](http://demo.bpmn.io/s/start)
88

9-
109
## Installation
1110

1211
Use the library [pre-packaged](https://github.com/bpmn-io/bpmn-js-examples/tree/master/pre-packaged)
@@ -36,7 +35,6 @@ try {
3635
Checkout our [examples](https://github.com/bpmn-io/bpmn-js-examples) for many
3736
more supported usage scenarios.
3837

39-
4038
### Dynamic Attach/Detach
4139

4240
You may attach or detach the viewer dynamically to any element on the page, too:
@@ -51,7 +49,6 @@ viewer.attachTo('#container');
5149
viewer.detach();
5250
```
5351

54-
5552
## Resources
5653

5754
* [Demo](http://demo.bpmn.io)
@@ -60,7 +57,6 @@ viewer.detach();
6057
* [Forum](https://forum.bpmn.io)
6158
* [Changelog](./CHANGELOG.md)
6259

63-
6460
## Build and Run
6561

6662
Prepare the project by installing all dependencies:
@@ -85,26 +81,22 @@ npm run dev
8581
You may need to perform [additional project setup](./docs/project/SETUP.md) when
8682
building the latest development snapshot.
8783

88-
8984
## Related
9085

9186
bpmn-js builds on top of a few powerful tools:
9287

9388
* [bpmn-moddle](https://github.com/bpmn-io/bpmn-moddle): Read / write support for BPMN 2.0 XML in the browsers
9489
* [diagram-js](https://github.com/bpmn-io/diagram-js): Diagram rendering and editing toolkit
9590

96-
9791
## Contributing
9892

9993
Please checkout our [contributing guidelines](./.github/CONTRIBUTING.md) if you plan to
10094
file an issue or pull request.
10195

102-
10396
## Code of Conduct
10497

10598
By participating to this project, please uphold to our [Code of Conduct](https://github.com/bpmn-io/.github/blob/master/.github/CODE_OF_CONDUCT.md).
10699

107-
108100
## License
109101

110102
Use under the terms of the [bpmn.io license](http://bpmn.io/license).

docs/project/SETUP.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,13 @@
22

33
This document describes the necessary steps to setup a `bpmn-js` development environment.
44

5-
65
## TLDR;
76

8-
On Linux, OS X or Windows? [git](http://git-scm.com/), [NodeJS](nodejs.org) and [npm](https://www.npmjs.org/doc/cli/npm.html) ready? Check out the [setup script section](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/SETUP.md#setup-via-script) below.
9-
7+
On Linux, OS X or Windows? [git](http://git-scm.com), [NodeJS](https://nodejs.org) and [npm](https://www.npmjs.org/doc/cli/npm.html) ready? Check out the [setup script section](#setup-via-script) below.
108

119
## Manual Steps
1210

13-
Make sure you have [git](http://git-scm.com/), [NodeJS](nodejs.org) and [npm](https://www.npmjs.org/doc/cli/npm.html) installed before you continue.
14-
11+
Make sure you have [git](http://git-scm.com), [NodeJS](https://nodejs.org) and [npm](https://www.npmjs.org/doc/cli/npm.html) installed before you continue.
1512

1613
### Get Project + Dependencies
1714

@@ -23,7 +20,7 @@ The following projects from the [bpmn-io](https://github.com/bpmn-io) project on
2320

2421
and clone them into a common directory via
2522

26-
```
23+
```sh
2724
git clone [email protected]:bpmn-io/bpmn-js.git
2825
git clone [email protected]:bpmn-io/diagram-js.git
2926
git clone [email protected]:bpmn-io/bpmn-moddle.git
@@ -33,7 +30,7 @@ git clone [email protected]:bpmn-io/bpmn-moddle.git
3330

3431
[Link dependent projects](https://docs.npmjs.com/cli/link) between each other to pick up changes immediately.
3532

36-
```
33+
```plain
3734
.
3835
├─bpmn-js
3936
│ └─node_modules
@@ -55,12 +52,10 @@ Use `mklink /d <link> <target>` [(docs)](http://technet.microsoft.com/en-us/libr
5552

5653
Execute `npm install` on each of the projects to grab their dependencies.
5754

58-
5955
### Verify Things are O.K.
6056

6157
Execute `npm run all` on each project. Things should be fine.
6258

63-
6459
### Setup via Script
6560

66-
The whole setup can be automated through setup scripts for [Linux/OS X](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.sh) and [Windows](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.bat).
61+
The whole setup can be automated through setup scripts for [Linux/OS X](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.sh) and [Windows](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.bat).

0 commit comments

Comments
 (0)