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.

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

Generate NAnt documentation with Wyam #16

Open
savornicesei opened this issue Jul 22, 2020 · 0 comments
Open

Generate NAnt documentation with Wyam #16

savornicesei opened this issue Jul 22, 2020 · 0 comments

Comments

@savornicesei
Copy link

savornicesei commented Jul 22, 2020

Hi @daveaglick ,

I'm trying to migrate NAnt documentation to wyam (and then to Statiq when Statiq.Docs will be stable and documented)
image

  1. I've managed to get the nant.xsd schema file copied as-is to wyam output but it does not appear in the sidebar. I've tried several variations but I could not get it right - either it generates an html file or it does not show in the sidebar).
 Pipelines.InsertBefore(Docs.RenderPages,"XMLSchema",
    ReadFiles("release/**/*.xsd"),
    Tree().WithMetadataNames(),
    Meta(DocsKeys.ShowInSidebar, true),
    Title("XML Schema"),
    CopyFiles("release/**/*.xsd")
);
 /*
 Pipelines.InsertBefore(Docs.RenderPages,"XMLSchema",
    ReadFiles("release/**/*.xsd.md"),
    FrontMatter(Yaml()),
    Title("XML Schema"),
    WriteFiles(".xsd")
);*/
 /*
Pipelines.InsertBefore(Docs.RenderPages,"XMLSchema",
    ReadFiles("release/**.xsd"),
    Tree(),
    Meta(DocsKeys.ShowInSidebar, true),
    Title("XML Schema"),
    WriteFiles()
);
*/
  1. I'm not sure how to generate the reference part of the documentation. I think the summary page(s) should look similar to Cake Add-Ins documentation but the actual documentation pages must show props and attributes in a specific order
    image

  2. Is it possible to use DirectoryMeta module to add metadata about the release version to all files from a release folder (e.g. /release/v0.92)? The documentation mentions some metadata document - should it be a markdown file with the needed metainfo in in in the root of the folder?
    Being able to set a Version metadata to all docs would allow me to generate correct links for that release.

You can check my work here.

Thank you for any insights you can give me (and for the awesome work on Wyam and its succesor).

All the best,
Simo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant