Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
    Tviljan
    @Tviljan
    Was not really simple or clear but It works now
    Tviljan
    @Tviljan
    I messing now with the template folders partial folder
    There are the .partial file and also uref folder. What is that?
    bitbonk
    @bitbonk
    This is awesome, I really hope it will intergrate well with docfx 3.0: https://devblogs.microsoft.com/dotnet/creating-interactive-net-documentation/
    @superyyrrzz Do you have this on your radar?
    Tviljan
    @Tviljan
    @superyyrrzz I am having trouble getting other comment blocks to my output. I can see them as empty in yml file
    How can I debug the TripleSlashCommentModel
    Tviljan
    @Tviljan
    I feel like when I call docfx.exe it never even touches the tripleSlashCommentModel
    Why I could add one custom comment element but not more?
    Tviljan
    @Tviljan
    Problem was that it cached the solution if it was not changed
    Tviljan
    @Tviljan
    Oh I believe there is a bug in the parser
    I had corrupted xml when I had a xml comment like this
        /// <caption>
        /// This is a caption for test method.....
        /// </caption>
        /// <description>
        ///This is a description
        /// </description>
    I had to add space to "This is a description"
    between /// and the "This is..." text
    Then it appeared
    Renze Yu
    @superyyrrzz
    @bitbonk v3 will use docs.microsoft.com as default template. Besides, I see these sample code is run as WebAssembly on client side. So this should be supported by default when v3 ships :smile:
    Renze Yu
    @superyyrrzz
    @Tviljan Glad to see it works finally. I am not sure whether the space is required. Maybe you can create a PR with proper tests to fix it.
    bitbonk
    @bitbonk
    @superyyrrzz when are you planning to release an update that includes this msbuild 16 support: dotnet/docfx#4595
    Renze Yu
    @superyyrrzz
    Now it targets around 6/10 @bitbonk
    girishzalke
    @girishzalke

    Hi, I am new to DocFx and trying to generate static website from the markdown files (currently on local machine but soon to be in VSTS Git Repo). I am able to generate static website (simple), but am not able to add Create Date / Last Updated Date into the generated HTML. What is the best approach to achieve this?

    Edit:
    Just to add information about my current structure in md files. I have the following section at the start of the file...

    title: Getting started with Web Apps
    description:
    author: Girish Zalke
    cust.date: 10/06/2019
    cust.topic: Getting started article
    helpviewer_keywords: Getting Started, Web Apps

    I'd like the cust.date to end up in the generated HTML file as Created Date or Last Updated Date.

    I will have a similar requirement for author but I guess I could follow the same solution as that for the cust.date.

    Renze Yu
    @superyyrrzz
    @girishzalke The rough idea is to custom template. You can use exportViewModel to examine how your data added to model, and to feed them into template.
    girishzalke
    @girishzalke
    Thank you @superyyrrzz . I will try that out.
    Chris Chinchilla
    @ChrisChinchilla

    Hey all. I want to add some new fields from the REST file into templates, but how do I debug what values are passed to the mustache parser?

    i.e., so I can see all the objects and their structure that might be available for render in a template.

    Hmm, maybe this is slightly similar to the question above 🤔
    bitbonk
    @bitbonk
    @superyyrrzz So how is the docfx v3 status? The roadmap hasn’t changed since January https://github.com/dotnet/docfx/blob/v3/docs/roadmap.md Any updates?
    hmmwhatsthisdo
    @hmmwhatsthisdo
    @superyyrrzz How would one access file metadata from the FileModel/host objects passed into a build step? I'm trying to implement the YAML-based document filter we discussed back in March, but it seems the plugin API isn't super well documented (a bit of irony, maybe)
    Renze Yu
    @superyyrrzz
    @ChrisChinchilla Yes, try exportViewModel.
    Renze Yu
    @superyyrrzz
    @bitbonk Work in progress according to the roadmap. We will update this soon to include the recent updates, around mid July.
    Renze Yu
    @superyyrrzz
    @hmmwhatsthisdo Could you create an issue to track this, then we can better track the context. You can start with https://dotnet.github.io/docfx/tutorial/howto_build_your_own_type_of_documentation_with_custom_plug-in.html#create-a-document-build-step . Put your main logic inside IEnumerable<FileModel> Prebuild(ImmutableList<FileModel> models, IHostService host). Your plugins's attribute should be [Export(nameof(ConceptualDocumentProcessor), typeof(IDocumentBuildStep))].
    hmmwhatsthisdo
    @hmmwhatsthisdo
    @superyyrrzz Right, I can open an issue here in a bit - I've already created a class that derives from BaseDocumentBuildStep and I'm trying to implement the Prebuild method now. I've already figured out how to extract the YAML header for a conceptual document via host.Markup().YamlHeader, but global/file metadata is something I'm not super sure about
    Renze Yu
    @superyyrrzz
    @hmmwhatsthisdo If you are accessing FileModel.Content from PreBuid/Build/PostBuild, global/file metadata are already there. There is a step before it to extract them from docfx.json into FileModel.
    Andrey Akinshin
    @AndreyAkinshin
    Hello everyone! Any ETA for the official v3 release?
    hmmwhatsthisdo
    @hmmwhatsthisdo
    Is there any way to override where DocFX stages plugins when running a build? It seems like DocFX expects it'll be able to write to the same directory that docfx.exe lives in (not the case if you install docfx.console from NuGet in system scope)
    Renze Yu
    @superyyrrzz
    @AndreyAkinshin Not determined for now. It will not be within 2019 as far as we can see.
    @hmmwhatsthisdo Not for now. Is there something blocking you? We do have issue complaining about this: dotnet/docfx#4835
    hmmwhatsthisdo
    @hmmwhatsthisdo
    @superyyrrzz pretty much the same thing as #4835 (but with NuGet instead of Chocolatey) - seems to only come into play when using plugins
    The primary use-case will entail DocFX being invoked via CI/CD inside of Azure DevOps, so I don't think this will be a problem there (depends on how Azure DevOps stages packages and such)
    Renze Yu
    @superyyrrzz
    That's fine
    Renze Yu
    @superyyrrzz
    @bitbonk @AndreyAkinshin You can see the latest v3 updates in this issue: dotnet/docfx#4874 Roadmap is also updated.
    Andrey Akinshin
    @AndreyAkinshin
    @superyyrrzz thanks for the update!
    dvy
    @donhuvy
    I hope the screenshot image inside main block (inside article page) can show big.
    Renze Yu
    @superyyrrzz
    @donhuvy Do you mean to increase the width of this particular image, or the width of the whole main article (exclude toc and side bar)?
    Chris Chinchilla
    @ChrisChinchilla

    Been scratching my brain on this one…

    What’s the file name template for adding a preprocessor to a partial template file?

    Chris Chinchilla
    @ChrisChinchilla
    rest.child.js? rest.child.partial.js?
    Something else?
    dvy
    @donhuvy
    @superyyrrzz thanh you, I have an answer for the question.
    a day before yesterday, I have an another problem at here https://stackoverflow.com/questions/57123518/docfx-search-at-top-right-corner-not-work
    please help me fix error in search box