Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor update to reflect the new format of the MD generator output #2380

Merged
merged 9 commits into from Feb 1, 2022
Merged

Minor update to reflect the new format of the MD generator output #2380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6b14894
Update docs for the new default cmake_layout() source folder
tapia Sep 14, 2021
a00843f
Merge branch 'develop' of https://github.com/conan-io/docs into develop
tapia Sep 15, 2021
cccbd81
Merge branch 'develop' of https://github.com/conan-io/docs into develop
tapia Nov 3, 2021
44cb070
Merge branch 'develop' of https://github.com/conan-io/docs into develop
tapia Feb 1, 2022
3caf45c
Minor update in reference/generators/markdown.rst to reflect the new …
tapia Feb 1, 2022
7ad175e
optimized image
tapia Feb 1, 2022
184f007
Update reference/generators/markdown.rst
tapia Feb 1, 2022
8e1f447
minor fixes
tapia Feb 1, 2022
5584c80
minor fixes
tapia Feb 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file modified images/conan-markdown_generator.png
View file
Open in desktop
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
View file
Open in desktop
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