Git Product home page Git Product logo

Comments (4)

dnndev avatar dnndev commented on August 15, 2024

Can we inject ourselves into build process to copy common content to appropriate sections.

Will a breadcrumb help?

from dnndocs.

CBPSC avatar CBPSC commented on August 15, 2024

For the user's experience it may be best to copy the common content to each section.

I also think a breadcrumb will be help in general to helping users understand where they are in the tree of documentation.

from dnndocs.

dnndev avatar dnndev commented on August 15, 2024

Looks like DocFX has a mechanism to include content from one .md file into another using markdown link syntax: https://dotnet.github.io/docfx/tutorial/links_and_cross_references.html#links-in-file-includes

We can use this to create a container page for, say, Glossary, in Admin and a Glossary contain in Developer (etc) and each container page would contain an include to a common file with the glossary content.

from dnndocs.

dnndev avatar dnndev commented on August 15, 2024

I've demonstrated how to do the includes using DocFX in commit 038649d

from dnndocs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.