In the next release of doxygen (1.8.3) I plan to introduce a new configuration option `USE_MDFILE_AS_MAINPAGE` which can be used to specify a markdown page that is to be used as the main page.
Then you can configure doxygen as follows:

    INPUT                  = README.md other_sources
    USE_MDFILE_AS_MAINPAGE = README.md

and it will work regardless of page&#39;s headings.

Try the following instead to mark the title as a level 1 header:

    Main Page {#mainpage}
    =========

With doxygen 1.8.2, this makes the page as the `index.html` page for me. 

The doxygen document does state that starting a line with a single `#` declares a level 1 header, but it seems to be not working for me either. 


I am learning perl and python... at the same time, not my by design but it has to be done.

Question:

In a perl script I use(see below) at the head of my txt.

    #!/usr/bin/env perl

    use strict;
    use warnings;

Is there something I should be doing on routine for my python scripts?


Does python have a &quot;use strict;&quot; and &quot;use warnings;&quot; like in perl?

there are some js files in static/js/

        1. a.js
        2. b.js
        3. c.js   

how to config grunt.js to get below files:
        
        1. a.min.js
        2. b.min.js
        3. c.min.js

as far, I have to type specific file name:
    
      min: {
        dist: {
        src:  &#39;js/**/*.js&#39;,
        dest: &#39;js/min/xxx.min.js&#39;
       }
     }


how to config grunt.js to minify files separately

The documentation of Doxygen states, that I can use PHP Markdown Extra title labelling in a markdown file, but neither

    # Main Page # {#mainpage}

nor

    # Main Page # {#index}

works, but the label is not present in the output as plain text either. This is the very first line BTW.

Also I cannot reference to that page neither with the above labels, neither with the name of the file.

I also have a `main.dox` file that contains a `\mainpage` special command, but I also tried all the above with removing one slash before them (to make it only two).

I&#39;m using Doxygen 1.8.2 (downloaded) and 1.8.1.1 (from MacPorts) for the task.

How can I achieve this then?

Also, how can I mark a markdown file as part of a specific language?

**EDIT:** i have enabled markdown support, and the file appears in the referenced pages.

Use the README.md file as main page in Doxygen

The documentation of Doxygen states, that I can use PHP Markdown Extra title labelling in a markdown file, but neither
<pre><code class="hljs language-less"># Main Page # {#mainpage}
</code></pre>
nor
<pre><code class="hljs language-less"># Main Page # {#index}
</code></pre>
works, but the label is not present in the output as plain text either. This is the very first line BTW.
Also I cannot reference to that page neither with the above labels, neither with the name of the file.
I also have a <code>main.dox</code> file that contains a <code>\mainpage</code> special command, but I also tried all the above with removing one slash before them (to make it only two).
I'm using Doxygen 1.8.2 (downloaded) and 1.8.1.1 (from MacPorts) for the task.
How can I achieve this then?
Also, how can I mark a markdown file as part of a specific language?
EDIT: i have enabled markdown support, and the file appears in the referenced pages.

I have created an RMarkdown file in RStudio and managed to knit it with knitr into an HTML and .md file.  Next, I used pandoc to convert the .md file into a PDF file (I get an error if I try and convert from the .html file).  However, the PDF that is produced have massive margins (like this [http://johnmacfarlane.net/pandoc/demo/example13.pdf][1]).  How can I get pandoc to produce something with smaller margins?  I have looked through the pandoc user guide, but haven&#39;t found anything useful.


  [1]: http://johnmacfarlane.net/pandoc/demo/example13.pdf

Set margin size when converting from Markdown to PDF with pandoc

I&#39;m trying to create a two-line `&lt;h1&gt;` in Markdown, something along the lines of:

    &lt;h1&gt;Title&lt;br/&gt;byline&lt;/h1&gt;

The Markdown docs say:

&gt; When you do want to insert a `&lt;br /&gt;` break tag using Markdown, you end a line with two or more spaces, then type return.

Unfortunately, this only seems to work for paragraphs -- if I try it with an `&lt;h1&gt;` (dots &#183; indicate spaces):

    #&#183;Title&#183;&#183;
    byline

the trailing spaces are ignored and I just get:

    &lt;h1&gt;Title&lt;/h1&gt;
    
    &lt;p&gt;byline&lt;/p&gt;

Can anyone tell me a workaround for this?

P.S. I&#39;m using vanilla Markdown 1.0.1 from the command line.

Force line break (&lt;br/&gt;) in header (&lt;h1&gt;) in Markdown

I know that an image can be placed in an MD with the MD syntax of either `![Alt text](/path/to/img.jpg)` or `![Alt text](/path/to/img.jpg &quot;Optional title&quot;)`, but I am having difficulty placing an SVG in MD where the code is hosted on GitHub.

Ultimately using rails3, and changing the model frequently right now, so I am using [RailRoady][1] to generate an SVG of the schema diagram of the models.  I would like for that SVG to then be placed in the ReadMe.md, and be displayed.  When I open the SVG file locally, it does work, so how do I get the browser to render the SVG in the MD file?  Given that the code will be dynamic until it is finalized (seemingly never), hosting the SVG in a separate place seems overkill and that I am missing an approach to accomplish this.

The SVG I am trying to include is [here][2] on GitHub: `https://github.com/specialorange/FDXCM/blob/master/Rails/fdxcm/doc/models_brief.svg`

I have tried the following, with an actual image as well to verify the syntax is working, just that the SVG code isn&#39;t being rendered:

	![Overview][1]
	[1]: https://github.com/specialorange/FDXCM/blob/master/doc/controllers_brief.svg  &quot;Overview&quot;

	&lt;img src=&quot;https://raw.github.com/specialorange/FDXCM/master/doc/controllers_brief.svg&quot;&gt;

	![Alt text](https://raw.github.com/specialorange/FDXCM/master/doc/controllers_brief.svg)

	[Google Doc](https://docs.google.com/drawings/d/1B95ajItJTAImL2WXISX0fkBLYk3nldea4Vm9eo-VyE4/edit) :

	&lt;img src=&quot;https://docs.google.com/drawings/pub?id=117XsJ1kDyaY-n8AdPS3_8jTgMyITqaoT3-ah_BSc9YQ&amp;w=960&amp;h=720&quot;&gt;

	&lt;img src=&quot;https://raw.github.com/specialorange/FDXCM/master/doc/controllers_brief.svg&quot;&gt;

	&lt;img src=&quot;https://docs.google.com/drawings/d/1B95ajItJTAImL2WXISX0fkBLYk3nldea4Vm9eo-VyE4/edit&quot;&gt;

to get the results of:

![Overview][1]
[1]: https://github.com/specialorange/FDXCM/blob/master/Rails/fdxcm/doc/controllers_brief.svg  &quot;Overview&quot;

&lt;img src=&quot;https://raw.github.com/specialorange/FDXCM/master/doc/controllers_brief.svg&quot;&gt;

![Alt text](https://raw.github.com/specialorange/FDXCM/master/doc/controllers_brief.svg)


----------


[Google Doc](https://docs.google.com/drawings/d/1B95ajItJTAImL2WXISX0fkBLYk3nldea4Vm9eo-VyE4/edit) :

&lt;img src=&quot;https://docs.google.com/drawings/pub?id=117XsJ1kDyaY-n8AdPS3_8jTgMyITqaoT3-ah_BSc9YQ&amp;w=960&amp;h=720&quot;&gt;

&lt;img src=&quot;https://raw.github.com/specialorange/FDXCM/master/doc/controllers_brief.svg&quot;&gt;

&lt;img src=&quot;https://docs.google.com/drawings/d/1B95ajItJTAImL2WXISX0fkBLYk3nldea4Vm9eo-VyE4/edit&quot;&gt;

  [1]: https://github.com/preston/railroady
  [2]: https://github.com/specialorange/FDXCM/blob/master/doc/models_brief.svg

Include an SVG (hosted on GitHub) in MarkDown

Does `markdown` support *native* text-alignment without usage `html` + `css`?

Markdown `native` text alignment

I&#39;m writing a web app in .NET MVC4 and would like to use Markdown.  I understand there are a few open source C# Markdown libraries, but I haven&#39;t found one that obviously supports embedding youtube or Vimeo videos inside Markdown text.

Does anyone know if it&#39;s possible?

Is it possible to embed Youtube/Vimeo videos in Markdown using a C# Markdown library

I am new to programming in general so I decided that I would start by making a simple vector class in C++.  However I would like to get in to good habits from the start rather than trying to modify my workflow later on.

I currently have only two files `vector3.hpp` and `vector3.cpp`. This project will slowly start to grow (making it much more of a general linear algebra library) as I become more familiar with everything, so I would like to adopt a &quot;standard&quot; project layout to make life easier later on.  So after looking around I have found two ways to go about organizing hpp and cpp files, the first being:


    project
    └── src
        ├── vector3.hpp
        └── vector3.cpp

and the second being:

    project
    ├── inc
    │   └── project
    │       └── vector3.hpp
    └── src
        └── vector3.cpp

Which would you recommend and why?

Secondly I would like to use the Google C++ Testing Framework for unit testing my code as it seems fairly easy to use. Do you suggest bundling this with my code, for example in a `inc/gtest` or `contrib/gtest` folder? If bundled, do you suggest using the `fuse_gtest_files.py` script to reduce the number or files, or leaving it as is?  If not bundled how is this dependency handled?

When it comes to writing tests, how are these generally organized?  I was thinking to have one cpp file for each class (`test_vector3.cpp` for example) but all compiled in to one binary so that they can all be run together easily?

Since the gtest library is generally build using cmake and make, I was thinking that it would make sense for my project to also be built like this?  If I decided to use the following project layout:

    ├── CMakeLists.txt
    ├── contrib
    │   └── gtest
    │       ├── gtest-all.cc
    │       └── gtest.h
    ├── docs
    │   └── Doxyfile
    ├── inc
    │   └── project
    │       └── vector3.cpp
    ├── src
    │   └── vector3.cpp
    └── test
        └── test_vector3.cpp

How would the `CMakeLists.txt` have to look so that it can either build just the library or the library and the tests?  Also I have seen quite a few projects that have a `build` and a `bin` directory.  Does the build happen in the build directory and then the binaries moved out in to the bin directory?  Would the binaries for the tests and the library live in the same place? Or would it make more sense to structure it as follows:

    test
    ├── bin
    ├── build
    └── src
        └── test_vector3.cpp

I would also like to use doxygen to document my code.  Is it possible to get this to automatically run with cmake and make?

Sorry for so many questions, but I have not found a book on C++ that satisfactorily answers these type of questions.

C++ project organisation (with gtest, cmake and doxygen)

I have the following Doxygen documentation for a function:

    /**
      @brief Does interesting things
    
      @param[in]  pfirst The first parameter: a barrel full of monkeys
    
      @pre
        &quot;pfirst&quot; must have been previously passed through BarrelFiller()
    */

Note that `pfirst` is a parameter, and that it is referenced in the preconditions.

I&#39;ve surrounded it with quotation marks here because I want to stand it off from the rest of the text. But it would be nice to do this in such a way that Doxygen will highlight the command and, preferably, link it to the parameter definition. Is there a way to do this?

It would be especially nice if this would happen using only the default configuration (or minor alterations thereof).

What&#39;s the right way to reference a parameter in Doxygen?

One of [Xcode 5&#39;s new features][1] is the ability to document your own code with a special comment syntax. The format is similar to doxygen, but appears to only support a subset of [those features][2].

Which commands are supported, and which ones aren&#39;t?   
Do any of their usages differ from doxygen?


  [1]: https://developer.apple.com/technologies/tools/features.html
  [2]: http://www.doxygen.nl/manual/commands.html

What are the new documentation commands available in Xcode 5?

I have an `R` package that uses `roxygen2`. It has some `C` code in `/src`, and I have just started working with `Doxygen`. Are there any ways to combine the documentation or integrate compiling with roxygen2? Any &quot;best practices&quot; for where to put the `C` code documentation?

Googling for roxygen2 and doxygen primarily leads to **roxygen is similar to doxygen** results. I have found a few packages with Doxyfiles, but no consistent organization. For example, `lme4` has [`inst/doc/Doxyfile`](https://github.com/lme4/lme4/) output to a folder called `doxygen` outside the `lme4` source directory. There is also a Doxyfile in the root directory of the Matrix (but in previous releases was in `inst`. This documentation is also exported outside the package directory.

Is there any reason not to include the `C` documentation inside a package, or why is Doxygen so infrequently used within R packages, despite widespread use of `C`?

**update:** see related [roxygen2 feature request](https://github.com/klutometis/roxygen/issues/326)

Using roxygen2 and doxygen on the same package?

I am creating a pdf of markdown text file using doxygen (1.8.6). Now I want to get page break at specific stage in markdown file, I used this [link][1].


  [1]: http://daringfireball.net/projects/markdown/syntax


In the given link they have mentioned to use &#39;&gt;&#39; for line break. But they haven&#39;t mentioned about page break. Yes I can use &#39;&gt;&#39; for page break as well but I have to write this symbol 5 or more times on markdown text file and that makes markdown file in weird look. Is there any other ways to get page breaks in markdown files?  

Content Type	Original Author	Original Content on Stackoverflow
Question	Adam L. S.	View Question on Stackoverflow
Solution 1 - Markdown	doxygen	View Answer on Stackoverflow
Solution 2 - Markdown	Masked Man	View Answer on Stackoverflow

Use the README.md file as main page in Doxygen

Markdown Problem Overview

Markdown Solutions

Solution 1 - Markdown

Solution 2 - Markdown

how to config grunt.js to minify files separately

Does python have a "use strict;" and "use warnings;" like in perl?

Attributions