public static string GenerateProjectReadme( IEnumerable <SnippetGeneratorResult> results, ProjectReadmeSettings settings) { MDocument document = Document(); return(GenerateProjectReadme(results, document, settings)); }
public static void WriteProjectReadme( string directoryPath, IEnumerable <SnippetGeneratorResult> results, ProjectReadmeSettings settings) { IOUtility.WriteAllText( Path.Combine(directoryPath, ReadMeFileName), MarkdownGenerator.GenerateProjectReadme(results, settings), IOUtility.UTF8NoBom); }
public static string GenerateProjectReadme( IEnumerable <SnippetGeneratorResult> results, MDocument document, ProjectReadmeSettings settings, bool addFootnote = true) { document.Add( (!string.IsNullOrEmpty(settings.Header)) ? Heading2(settings.Header) : null, BulletItem("Browse all available snippets with ", Link("Snippet Browser", GetSnippetBrowserUrl(settings.Environment.Kind)), "."), BulletItem("Download extension from ", Link("Marketplace", $"http://marketplace.visualstudio.com/search?term=publisher%3A\"Josef%20Pihrt\"%20{ProductName}&target={settings.Environment.Kind.GetIdentifier()}&sortBy=Name"), "."), Heading3("Snippets"), Table( TableRow("Group", "Count", TableColumn(HorizontalAlignment.Right)), results.OrderBy(f => f.DirectoryName).Select(f => { return(TableRow( Link(f.DirectoryName, $"{VisualStudioExtensionGitHubUrl}/{f.DirectoryName}/{ReadMeFileName}"), f.Snippets.Count, Link("Browse", GetSnippetBrowserUrl(settings.Environment.Kind, f.Language)))); }))); return(document.GetString(addFootnote: addFootnote)); }