Skip to content

Commit

Permalink
Minor update to reflect the new format of the MD generator output (#2380
Browse files Browse the repository at this point in the history
)

* Update docs for the new default cmake_layout() source folder

* Minor update in reference/generators/markdown.rst to reflect the new format of the generated files

* optimized image

* Update reference/generators/markdown.rst

Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>

* minor fixes

* minor fixes

Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
  • Loading branch information
tapia and czoido committed Feb 1, 2022
1 parent dcc9225 commit f089c9f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
Binary file modified images/conan-markdown_generator.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 5 additions & 6 deletions reference/generators/markdown.rst
Expand Up @@ -5,14 +5,14 @@ markdown


This generator creates a *.md* file for each requirement with useful information to consume
the installed packages: libraries available, headers, compiler flags, snippet to consume them
using different build systems,...
the installed packages: libraries available, components, headers, and basic instructions to
consume them using different build systems.

.. code-block:: bash
$ conan install libxml2/2.9.9@ --generator markdown
$ conan install poco/1.11.1@ --generator markdown
...
Generator markdown created libxml2.md
Generator markdown created poco.md
Although markdown files can be read in plain text, we highly recommend you to use any plugin
Expand All @@ -21,7 +21,6 @@ markdown documents).


.. image:: /images/conan-markdown_generator.png
:alt: Markdown generator output for ``libxml2/2.9.9`` package.
:alt: Markdown generator output for ``poco/1.11.1`` package.
:width: 800 px
:align: center

0 comments on commit f089c9f

Please sign in to comment.