Skip to content

Commit 6d6e79c

Browse files
author
Shammamah Hossain
committed
Regenerate docs to link to the correct files.
1 parent 34fcbf1 commit 6d6e79c

18 files changed

+19
-20
lines changed

‎bin/generateDocs

+2-3
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,7 @@ async function documentComponent (componentPath, docPath) {
7373

7474
const doc = reactDocgen.parse(fileContent);
7575
const markdown = renderer.render(componentPath, doc, [])
76-
.replace(`${componentName}.react`, componentName)
77-
.split('src/components').join('/src/components')
76+
.split('src/components').join('/src/components')
7877

7978
return fs.writeFile(docPath, markdown);
8079
}
@@ -86,4 +85,4 @@ function getDocFilename (componentPath) {
8685

8786
function getComponentName (componentPath) {
8887
return path.basename(componentPath).split('.').shift();
89-
}
88+
}

‎docs/BooleanSwitch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## BooleanSwitch
33

4-
Component file: [`/src/components/BooleanSwitch.js`](/src/components/BooleanSwitch.react.js)
4+
Component file: [`/src/components/BooleanSwitch.react.js`](/src/components/BooleanSwitch.react.js)
55

66
A switch component that toggles
77
between on and off.

‎docs/ColorPicker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## ColorPicker
33

4-
Component file: [`/src/components/ColorPicker.js`](/src/components/ColorPicker.react.js)
4+
Component file: [`/src/components/ColorPicker.react.js`](/src/components/ColorPicker.react.js)
55

66
A color picker.
77

‎docs/DarkThemeProvider.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## DarkThemeProvider
33

4-
Component file: [`/src/components/DarkThemeProvider.js`](/src/components/DarkThemeProvider.react.js)
4+
Component file: [`/src/components/DarkThemeProvider.react.js`](/src/components/DarkThemeProvider.react.js)
55

66
DarkThemeProvider is a component that is placed at the root of
77
the component tree to make all components match the dark theme

‎docs/Gauge.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## Gauge
33

4-
Component file: [`/src/components/Gauge.js`](/src/components/Gauge.react.js)
4+
Component file: [`/src/components/Gauge.react.js`](/src/components/Gauge.react.js)
55

66
A Gauge component that points to
77
a value between some range.

‎docs/GraduatedBar.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## GraduatedBar
33

4-
Component file: [`/src/components/GraduatedBar.js`](/src/components/GraduatedBar.react.js)
4+
Component file: [`/src/components/GraduatedBar.react.js`](/src/components/GraduatedBar.react.js)
55

66
A graduated bar component that displays
77
a value within some range as a

‎docs/Indicator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## Indicator
33

4-
Component file: [`/src/components/Indicator.js`](/src/components/Indicator.react.js)
4+
Component file: [`/src/components/Indicator.react.js`](/src/components/Indicator.react.js)
55

66
A boolean indicator LED.
77

‎docs/Joystick.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## Joystick
33

4-
Component file: [`/src/components/Joystick.js`](/src/components/Joystick.react.js)
4+
Component file: [`/src/components/Joystick.react.js`](/src/components/Joystick.react.js)
55

66
A joystick.
77

‎docs/Knob.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## Knob
33

4-
Component file: [`/src/components/Knob.js`](/src/components/Knob.react.js)
4+
Component file: [`/src/components/Knob.react.js`](/src/components/Knob.react.js)
55

66
A knob component that can be turned
77
to a value between some range.

‎docs/LEDDisplay.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## LEDDisplay
33

4-
Component file: [`/src/components/LEDDisplay.js`](/src/components/LEDDisplay.react.js)
4+
Component file: [`/src/components/LEDDisplay.react.js`](/src/components/LEDDisplay.react.js)
55

66
A 7-bar LED display component.
77

‎docs/NumericInput.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## NumericInput
33

4-
Component file: [`/src/components/NumericInput.js`](/src/components/NumericInput.react.js)
4+
Component file: [`/src/components/NumericInput.react.js`](/src/components/NumericInput.react.js)
55

66
A numeric input component that can be
77
set to a value between some range.

‎docs/PowerButton.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## PowerButton
33

4-
Component file: [`/src/components/PowerButton.js`](/src/components/PowerButton.react.js)
4+
Component file: [`/src/components/PowerButton.react.js`](/src/components/PowerButton.react.js)
55

66
A power button component can be
77
turned on and off.

‎docs/PrecisionInput.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## PrecisionInput
33

4-
Component file: [`/src/components/PrecisionInput.js`](/src/components/PrecisionInput.react.js)
4+
Component file: [`/src/components/PrecisionInput.react.js`](/src/components/PrecisionInput.react.js)
55

66
A numeric input component that converts
77
an input value to the desired precision.

‎docs/Slider.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## Slider
33

4-
Component file: [`/src/components/Slider.js`](/src/components/Slider.react.js)
4+
Component file: [`/src/components/Slider.react.js`](/src/components/Slider.react.js)
55

66
A slider component with support for
77
a target value.

‎docs/StopButton.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## StopButton
33

4-
Component file: [`/src/components/StopButton.js`](/src/components/StopButton.react.js)
4+
Component file: [`/src/components/StopButton.react.js`](/src/components/StopButton.react.js)
55

66
A Stop button component
77

‎docs/Tank.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## Tank
33

4-
Component file: [`/src/components/Tank.js`](/src/components/Tank.react.js)
4+
Component file: [`/src/components/Tank.react.js`](/src/components/Tank.react.js)
55

66
A Tank component that fills to
77
a value between some range.

‎docs/Thermometer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## Thermometer
33

4-
Component file: [`/src/components/Thermometer.js`](/src/components/Thermometer.react.js)
4+
Component file: [`/src/components/Thermometer.react.js`](/src/components/Thermometer.react.js)
55

66
A thermometer component that
77
fills to a value between some

‎docs/ToggleSwitch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## ToggleSwitch
33

4-
Component file: [`/src/components/ToggleSwitch.js`](/src/components/ToggleSwitch.react.js)
4+
Component file: [`/src/components/ToggleSwitch.react.js`](/src/components/ToggleSwitch.react.js)
55

66
A switch component that toggles between
77
two values.

0 commit comments

Comments
 (0)