Skip to content

Commit 3fef108

Browse files
committed
Prettify markdown files
1 parent af17c5d commit 3fef108

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

ROADMAP.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export class Gitgraph extends GitgraphCore {
3838
// all specific options
3939
this.$el = options.$el || $("#gitgraph");
4040
}
41-
41+
4242
render() {
4343
// my awesome render
4444
this.log().map(...)
@@ -56,18 +56,18 @@ export default class Gitgraph extends React.Component {
5656
super(props);
5757
this.gitgraph = new GitgraphCore(props.options);
5858
// Not really sure about this pattern
59-
this.gitgraph.log$.subscribe(store => this.setState({store}));
60-
59+
this.gitgraph.log$.subscribe((store) => this.setState({ store }));
60+
6161
if (props.ref) props.ref(this.gitgraph);
6262
}
63-
63+
6464
render() {}
6565
}
6666
```
6767

6868
### packages/gitgraph-js
6969

70-
The idea here is to never use `gitgraph-core` directly. We'll bundle it into different rendering engines.
70+
The idea here is to never use `gitgraph-core` directly. We'll bundle it into different rendering engines.
7171

7272
Gitgraph-js will work more or less with the same API than v1: it takes a selector or an `$el` and that's it. We may move from canvas to svg, or use a combination of both if relevant.
7373

@@ -114,7 +114,7 @@ Functional component with children:
114114
import React from "react";
115115
import Gitgraph, {Commit, Branch} from "gitgraph-react";
116116

117-
export default () =>
117+
export default () =>
118118
<Gitgraph options={{template: "blackarrow"}}>
119119
<Branch name="master">
120120
<Commit message="hello" />
@@ -135,7 +135,7 @@ With git API − declarative mode:
135135
import React from "react";
136136
import Gitgraph, {Commit, Branch, Checkout, Merge} from "gitgraph-react";
137137

138-
export default () =>
138+
export default () =>
139139
<Gitgraph options={{template: "blackarrow"}}>
140140
<Branch name="master" />
141141
<Commit message="hello" />
@@ -157,7 +157,7 @@ Functional component with render props:
157157
import React from "react";
158158
import Gitgraph from "gitgraph-react";
159159

160-
export default () =>
160+
export default () =>
161161
<Gitgraph options={{template: "blackarrow"}}>
162162
{ gitgraph => {
163163
const master = gitgraph.branch("master");
@@ -171,4 +171,4 @@ export default () =>
171171
} }
172172
</Gitgraph>
173173
}
174-
```
174+
```

packages/gitgraph-core/README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
![gitgraph.js](/assets/logo/gitgraph-logo.png)
22

3-
[![Build Status](https://secure.travis-ci.org/nicoespeon/gitgraph.js.png)](http://travis-ci.org/nicoespeon/gitgraph.js)
4-
===========
3+
# [![Build Status](https://secure.travis-ci.org/nicoespeon/gitgraph.js.png)](http://travis-ci.org/nicoespeon/gitgraph.js)
54

65
A JavaScript library to draw pretty git graphs in the browser.
76

@@ -11,11 +10,11 @@ Project page: <http://gitgraphjs.com/>
1110

1211
You have different options to start with the library:
1312

14-
* [Download the latest release](https://github.com/nicoespeon/gitgraph.js/releases/latest).
15-
* Clone the repo: `git clone [email protected]:nicoespeon/gitgraph.js.git`.
16-
* Install with [npm](https://www.npmjs.com): `npm install --save gitgraph.js`.
17-
* Install with [Bower](http://bower.io/): `bower install gitgraph.js`.
18-
* Use [the CDNjs hosted lib](https://cdnjs.com/libraries/gitgraph.js).
13+
- [Download the latest release](https://github.com/nicoespeon/gitgraph.js/releases/latest).
14+
- Clone the repo: `git clone [email protected]:nicoespeon/gitgraph.js.git`.
15+
- Install with [npm](https://www.npmjs.com): `npm install --save gitgraph.js`.
16+
- Install with [Bower](http://bower.io/): `bower install gitgraph.js`.
17+
- Use [the CDNjs hosted lib](https://cdnjs.com/libraries/gitgraph.js).
1918

2019
Production files are available under the `build/` directory.
2120

@@ -66,11 +65,11 @@ Releases will be numbered with the following format:
6665

6766
And constructed with the following guidelines:
6867

69-
* Breaking backward compatibility bumps the `<major>` (and resets the `<minor>`
68+
- Breaking backward compatibility bumps the `<major>` (and resets the `<minor>`
7069
and `<patch>`)
71-
* New additions without breaking backward compatibility bump the `<minor>` (and
70+
- New additions without breaking backward compatibility bump the `<minor>` (and
7271
reset the `<patch>`)
73-
* Bug fixes and misc. changes bump the `<patch>`
72+
- Bug fixes and misc. changes bump the `<patch>`
7473

7574
## Authors and contributors
7675

0 commit comments

Comments
 (0)