Skip to content

Commit 2459dd2

Browse files
committed
update README and generate invalid links
1 parent 757aedf commit 2459dd2

File tree

4 files changed

+21
-8
lines changed

4 files changed

+21
-8
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,23 @@ To get a feel for how Moxygen works you can play with the example which is locat
5454
* Pre-generated XML output in [example/xml](/example/xml)
5555
* Pre-generated output Markdown files in [example/doc](/example/doc)
5656

57-
The rebuild the example XML you can run `doxygen` from within the example folder.
57+
To fully build the example, follow these steps (once you've installed `doxygen`. See **Development & Contribution**, below):
5858

59-
Now you can build the example documentation with the following command from within the example folder:
59+
1. Rebuild the XML: run `doxygen` from within the example folder.
60+
2. Rebuild the Moxygen output: from within this directory,
6061

6162
```
62-
moxygen --anchors --groups --output=example/doc/api-%s.md example/xml
63+
node bin/moxygen.js --groups --pages --anchors --output=example/doc/api-%s.md example/xml
6364
```
65+
66+
## Development & Contribution
67+
68+
You can develop this project as you would any other Node project:
69+
70+
1. Clone this repo.
71+
2. `npm install` from this directory.
72+
73+
This project is tested through integration, by building the `example/`. To quickly test this project:
74+
75+
1. Install `doxygen` (`brew install doxygen`, `choco install doxygen`, for example). Only must be done once per computer.
76+
2. `npm test` from this directory. This will run Doxygen on the `example/` and build the output.

example/doc/api-mountainbike.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Mountain bike module contains the `MountainBike` class. Mountain bikes are a kin
66

77
Members | Descriptions
88
--------------------------------|---------------------------------------------
9-
`class `[`transport::MountainBike`](#classtransport_1_1MountainBike) | Mountain bike implementation of a `[Bicycle](./api-bicycle.md#classtransport_1_1Bicycle)`.
9+
`class `[`transport::MountainBike`](#classtransport_1_1MountainBike) | Mountain bike implementation of a `[Bicycle](example/doc/api-bicycle.md#classtransport_1_1Bicycle)`.
1010

1111
# class `transport::MountainBike` {#classtransport_1_1MountainBike}
1212

@@ -15,9 +15,9 @@ class transport::MountainBike
1515
: public transport::Bicycle
1616
```
1717

18-
Mountain bike implementation of a `[Bicycle](./api-bicycle.md#classtransport_1_1Bicycle)`.
18+
Mountain bike implementation of a `[Bicycle](example/doc/api-bicycle.md#classtransport_1_1Bicycle)`.
1919

20-
[MountainBike](#classtransport_1_1MountainBike) is an implementation of a [Bicycle](./api-bicycle.md#classtransport_1_1Bicycle) providing a bike for cycling on rough terrain. Mountain bikes are pretty cool because they have stuff like **Suspension** (and you can even adjust it using SetSuspension). If you're looking for a bike for use on the road, you might be better off using a [RacingBike](./api-racingbike.md#classtransport_1_1RacingBike) though.
20+
[MountainBike](#classtransport_1_1MountainBike) is an implementation of a [Bicycle](example/doc/api-bicycle.md#classtransport_1_1Bicycle) providing a bike for cycling on rough terrain. Mountain bikes are pretty cool because they have stuff like **Suspension** (and you can even adjust it using SetSuspension). If you're looking for a bike for use on the road, you might be better off using a [RacingBike](example/doc/api-racingbike.md#classtransport_1_1RacingBike) though.
2121

2222
## Summary
2323

example/doc/page-md_src_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# page `md_src_overview` {#md_src_overview}
22

3-
The `transport` namespace provides several differnt types of bycicles, including [transport::Bicycle](./api-bicycle.md#classtransport_1_1Bicycle), [transport::MountainBike](./api-mountainbike.md#classtransport_1_1MountainBike) (designed for rough terrain), and [transport::RacingBike](./api-racingbike.md#classtransport_1_1RacingBike) (designed specifically for challenging races).
3+
The `transport` namespace provides several differnt types of bycicles, including [transport::Bicycle](example/doc/api-bicycle.md#classtransport_1_1Bicycle), [transport::MountainBike](example/doc/api-mountainbike.md#classtransport_1_1MountainBike) (designed for rough terrain), and [transport::RacingBike](example/doc/api-racingbike.md#classtransport_1_1RacingBike) (designed specifically for challenging races).
44

55
## Changelog
66

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"main": "index.js",
66
"scripts": {
77
"release": "release-it",
8-
"test": "cd example/ && doxygen && cd doc/ && node ../../bin/moxygen.js ../xml -o ./api-%s.md --groups --pages --anchors"
8+
"test": "cd example/ && doxygen && cd .. && node bin/moxygen.js --groups --pages --anchors --output=example/doc/api-%s.md example/xml"
99
},
1010
"bin": {
1111
"moxygen": "./bin/moxygen.js"

0 commit comments

Comments
 (0)