Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
V
VizBlocksFramework
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Container Registry
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Design Informatics
VizBlocks
VizBlocksFramework
Commits
42d67bef
Commit
42d67bef
authored
4 years ago
by
mhamilt7
Browse files
Options
Downloads
Patches
Plain Diff
add markdown and styling notes
parent
0221f3a1
No related branches found
No related tags found
3 merge requests
!4
Joe merge
,
!3
Doxygen Documentation
,
!2
Docs
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/README.md
+30
-0
30 additions, 0 deletions
docs/README.md
with
30 additions
and
0 deletions
docs/README.md
+
30
−
0
View file @
42d67bef
...
...
@@ -79,3 +79,33 @@ run in the command line as
cd path/to/repo/
doxygen Doxyfile
```
### Markdown
[Doxygen supports Markdown!](http://www.doxygen.nl/manual/markdown.html) So you can use markdown in comment blocks if necessary.
In the doxygen file you can also point the frontpage to a `
.md
` file.
```make
USE_MDFILE_AS_MAINPAGE =
```
This will populate the mainpage with html from the specified markdown file.
### Custom Output
You can specify a html header, footer and custom css files. The easiest approach would be to generate these first
```sh
doxygen -w html header.html footer.html customdoxygen.css
```
then edit them as necessary.
Change these options in the Doxyfile
```make
HTML_HEADER = header.html
HTML_FOOTER = footer.html
HTML_EXTRA_STYLESHEET = my_customdoxygen.css
``
`
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment