Welcome to SpecFlow+ LivingDoc's documentation! =============================================== SpecFlow+LivingDoc is a set of tools that allows you to share and collaborate on Gherkin Feature Files with stakeholders who may not be familiar with developer tools. SpecFlow+LivingDoc gives you the option to generate & share living documentation in two configurable ways: * :doc:`SpecFlow+LivingDoc for Azure DevOps <./Installation/Installation>`: If your team uses Azure DevOps then we suggest installing our dedicated extension to help you generate and share LivingDoc within the familiar Azure DevOps interface. * :doc:`SpecFlow+LivingDoc Generator <./LivingDocGenerator/Generating-Documentation>`: If you want to generate a self-hosted HTML documentation with no external dependencies so you have the freedom to share it as you wish, then we suggest the SpecFlow plugin and command-line tool. .. note:: You will find all the information related to LivingDoc on this page. If you are new to LivingDoc, check out the **Step-by-step guides** section to get started. Sample output: .. image:: _static/images/sample_output3.png .. toctree:: :maxdepth: 1 :caption: Step-by-step guides :hidden: sbsguides/sbsazdo.md sbsguides/sbscli.md .. toctree:: :maxdepth: 1 :caption: LivingDoc IN AZURE DEVOPS :hidden: Generating/Generating-Documentation.md Installation/Installation.md Generating/Adding-a-Build-Step.md Generating/Configuring-the-Build-Step-in-DevOps.md Generating/Configuring-the-Build-Step-in-YAML.md .. toctree:: :maxdepth: 1 :caption: LivingDoc Generator :hidden: LivingDocGenerator/Generating-Documentation.md LivingDocGenerator/Setup-the-LivingDocPlugin.md LivingDocGenerator/Installing-the-command-line-tool.md LivingDocGenerator/Using-the-command-line-tool.md LivingDocGenerator/CLI/livingdoc-feature-folder.md LivingDocGenerator/CLI/livingdoc-test-assembly.md LivingDocGenerator/CLI/livingdoc-feature-data.md .. toctree:: :maxdepth: 1 :caption: Viewing LivingDoc :hidden: Viewing/viewing-livingdoc-azdo.md Viewing/viewing-livingdoc-standalone.md LivingDocGenerator/Test-execution-results.md Viewing/livingdoc-analytics.md LivingDocGenerator/Unused-step-definition-report.md Viewing/Searching.md .. toctree:: :maxdepth: 1 :caption: Enhancing LivingDoc :hidden: Generating/Markdown-and-Embedding-Images.md Viewing/internal-linking.md Viewing/Linking.md Viewing/Editing-Feature-Files.md Generating/Documentation-Languages.md Guides/Title-branch-name.md Guides/outputapild.md .. toctree:: :maxdepth: 1 :caption: Sharing LivingDoc :hidden: LivingDocGenerator/sharing-and-publishing.md .. toctree:: :maxdepth: 1 :caption: Guides :hidden: Guides/Generator-Migration-v3.4-v3.5 Guides/Troubleshooting.md Guides/Merging-Multiple-test-results.md Guides/azdoreleasepipeline.md Guides/azureblobstorage.md .. toctree:: :maxdepth: 1 :caption: Version History :hidden: VersionHistory/LivingDoc-AzDo-history.md VersionHistory/LivingDoc-Generator-history.md LivingDocGenerator/Known-issues.md