Skip to content

Commit d51aee2

Browse files
committed
chore: mention for each READMEs, bold instead of italics
1 parent d37dc86 commit d51aee2

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ You will need Nodejs LTS v14.16.x, VSCode, Vetur, and pnpm package manager.
2121

2222
- If you want to test building the app locally, run `pnpm run build`. This will generate the `dist` directory which contains all the codes for the app to run from CDN or web server. You can test the built codes in the `dist` with `pnpm run serve`. However, changes won't be updated on the app with this command.
2323

24+
Please see `README.md` in the respective directories of `src` to see what the respective directory contains.
25+
2426
## Dependencies Explanation
2527

2628
Code-Generator mainly depends on

src/components/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@ This directory contains components - building blocks used in the Code-Generator
44

55
## components description
66

7-
- [`CodeBlock.vue`](CodeBlock.vue) – This component is used to display the _code_ with respective syntax highlightning and line numbers. This is used in [`PaneRight.vue`](PaneRight.vue).
7+
- [`CodeBlock.vue`](CodeBlock.vue) – This component is used to display the **code** with respective syntax highlightning and line numbers. This is used in [`PaneRight.vue`](PaneRight.vue).
88

9-
- [`FormCheckbox.vue`](FormCheckbox.vue) – This component is used to display the _checkbox_ with its respective label. This is used in [`TabHandlers.vue`](TabHandlers.vue) and [`TabTraining.vue`](TabTraining.vue).
9+
- [`FormCheckbox.vue`](FormCheckbox.vue) – This component is used to display the **checkbox** with its respective label. This is used in [`TabHandlers.vue`](TabHandlers.vue) and [`TabTraining.vue`](TabTraining.vue).
1010

11-
- [`FormInput.vue`](FormInput.vue) – This component is used to display the _input box_ with its respective label. This is used in [`TabHandlers.vue`](TabHandlers.vue), [`TabLoggers.vue`](TabLoggers.vue), and [`TabTraining.vue`](TabTraining.vue).
11+
- [`FormInput.vue`](FormInput.vue) – This component is used to display the **input box** with its respective label. This is used in [`TabHandlers.vue`](TabHandlers.vue), [`TabLoggers.vue`](TabLoggers.vue), and [`TabTraining.vue`](TabTraining.vue).
1212

13-
- [`FormSelect.vue`](FormSelect.vue) – This component is used to display the _select dropdown_ with its respective label and options. This is used in [`TabLoggers.vue`](TabLoggers.vue) and [`TabModel.vue`](TabModel.vue).
13+
- [`FormSelect.vue`](FormSelect.vue) – This component is used to display the **select dropdown** with its respective label and options. This is used in [`TabLoggers.vue`](TabLoggers.vue) and [`TabModel.vue`](TabModel.vue).
1414

15-
- [`NavBar.vue`](NavBar.vue) – This component is used to display the _navigation bar (header image, name, download button, and external links)_ of the app. This is used in [`App.vue`](../App.vue).
15+
- [`NavBar.vue`](NavBar.vue) – This component is used to display the **navigation bar (header image, name, download button, and external links)** of the app. This is used in [`App.vue`](../App.vue).
1616

17-
- [`PaneLeft.vue`](PaneLeft.vue) – This component is used to display the _left_ pane of the app which includes tab heading and show the respective tab contents.
17+
- [`PaneLeft.vue`](PaneLeft.vue) – This component is used to display the **left** pane of the app which includes tab heading and show the respective tab contents.
1818

19-
- [`PaneRight.vue`](PaneRight.vue) – This component is used to display the _right_ pane of the app which includes tab heading and show the respective tab contents.
19+
- [`PaneRight.vue`](PaneRight.vue) – This component is used to display the **right** pane of the app which includes tab heading and show the respective tab contents.
2020

21-
- [`PaneSplit.vue`](PaneSplit.vue) – This component is used to display the _main pane_ of the app (excludes navigation bar) which includes the space for left pane, middle split line, and the space of right pane. It does not display any content, it occupies the space needed for left pane, split line, and right pane. And then, in the [`App.vue`](../App.vue), [`PaneLeft.vue`](PaneLeft.vue) takes up the left pane and show content. Same goes for [`PaneRight.vue`](PaneRight.vue).
21+
- [`PaneSplit.vue`](PaneSplit.vue) – This component is used to display the **main pane** of the app (excludes navigation bar) which includes the space for left pane, middle split line, and the space of right pane. It does not display any content, it occupies the space needed for left pane, split line, and right pane. And then, in the [`App.vue`](../App.vue), [`PaneLeft.vue`](PaneLeft.vue) takes up the left pane and show content. Same goes for [`PaneRight.vue`](PaneRight.vue).
2222

23-
- [`TabHandlers.vue`](TabHandlers.vue) – This components shows the content of _handlers_ tab of the app.
23+
- [`TabHandlers.vue`](TabHandlers.vue) – This components shows the content of **handlers** tab of the app.
2424

25-
- [`TabLoggers.vue`](TabLoggers.vue) – This components shows the content of _loggers_ tab of the app.
25+
- [`TabLoggers.vue`](TabLoggers.vue) – This components shows the content of **loggers** tab of the app.
2626

27-
- [`TabModel.vue`](TabModel.vue) – This components shows the content of _model_ tab of the app.
27+
- [`TabModel.vue`](TabModel.vue) – This components shows the content of **model** tab of the app.
2828

29-
- [`TabTraining.vue`](TabTraining.vue) – This components shows the content of _training_ tab of the app.
29+
- [`TabTraining.vue`](TabTraining.vue) – This components shows the content of **training** tab of the app.

0 commit comments

Comments
 (0)