Skip to content

Commit dc824ad

Browse files
committed
Update README
1 parent 86f9f96 commit dc824ad

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

+19-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
# Moxygen
22

3-
Moxygen is a doxygen XML to markdown converter that fills the need for developers who have been craving a beautiful and minimal documentation alternative for their C++ projects.
3+
Moxygen is a doxygen XML to markdown converter for developers who want a beautiful and minimal documentation solution for their C++ projects.
44

5-
The code is a heavily modified port of `doxygen2md` with a focus on generating multi page documentation from doxygen [modules](http://www.stack.nl/~dimitri/doxygen/manual/grouping.html#modules).
5+
The code is based on `doxygen2md` with extra options for generating output files, custom templates, and generating multipage documentation.
66

7-
Moxygen is the API documentation generator used by LibSourcey, the result of which can be seen [here](http://sourcey.com/libsourcey/).
7+
Moxygen is currently used in conjunction with GitBook to generate the API documentation for LibSourcey, which can be viewed [here](http://sourcey.com/libsourcey/).
88

99
## Usage
1010

11-
1. Run `doxygen` to generate the XML documentation.
12-
2. Run `moxygen` providing the folder location of the XML documentation.
13-
11+
1. Add `GENERATE_XML=YES` to your `Doxyfile` first.
12+
2. Run `doxygen` to generate the XML documentation.
13+
3. Install `moxygen` like so: `npm install moxygen -g`.
14+
4. Run `moxygen` providing the folder location of the XML documentation as the first argument ie. `{OUTPUT_DIRECTORY}/xml`.
1415
```
1516
Usage: moxygen [options] <doxygen directory>
1617
@@ -25,3 +26,15 @@ Moxygen is the API documentation generator used by LibSourcey, the result of whi
2526
-t, --templates <dir> custom templates directory
2627
-o, --output <file> output file (must contain %s when using modules)
2728
```
29+
30+
## Multipage Output
31+
32+
Moxygen supports the doxygen [modules](http://www.stack.nl/~dimitri/doxygen/manual/grouping.html#modules) syntax for generating multipage documentation.
33+
34+
Every [\defgroup](http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddefgroup) in your source code will be parsed and output into a separate markdown file, with internal reference updated accordingly.
35+
36+
Example:
37+
38+
```
39+
moxygen --anchors --modules --output api-%s.md /path/to/doxygen/xml
40+
```

0 commit comments

Comments
 (0)