mm-docs-template

Template to use with mm-docs (by majkinetor)

Mm-docs-template Alternatives

Similar projects and alternatives to mm-docs-template

  1. Optic

    12 mm-docs-template VS Optic

    OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.

  2. Nutrient

    Nutrient - The #1 PDF SDK Library. Bad PDFs = bad UX. Slow load times, broken annotations, clunky UX frustrates users. Nutrient’s PDF SDKs gives seamless document experiences, fast rendering, annotations, real-time collaboration, 100+ features. Used by 10K+ devs, serving ~half a billion users worldwide. Explore the SDK for free.

    Nutrient logo
  3. mm-docs

    Documentation system in a docker container using mkdocs, plantuml and many more

  4. log4brains

    ✍️ Architecture Decision Records (ADR) management and publication tool

  5. Doxide

    Modern documentation for modern C++. Configure with YAML, output Markdown, post-process with Material for MkDocs.

  6. pydoc-markdown

    Create Python API documentation in Markdown format.

  7. docs

    The documentation for Firefly III (by firefly-iii)

  8. MkDocs

    Project documentation with Markdown.

  9. CodeRabbit

    CodeRabbit: AI Code Reviews for Developers. Revolutionize your code reviews with AI. CodeRabbit offers PR summaries, code walkthroughs, 1-click suggestions, and AST-based analysis. Boost productivity and code quality across all major languages with each PR.

    CodeRabbit logo
  10. EntityFramework.Docs

    Documentation for Entity Framework Core and Entity Framework 6

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a better mm-docs-template alternative or higher similarity.

mm-docs-template discussion

Log in or Post with

mm-docs-template reviews and mentions

Posts with mentions or reviews of mm-docs-template. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2021-03-10.
  • Why Your Company's Documentation Sucks
    2 projects | news.ycombinator.com | 10 Mar 2021
    This view is too much simplified. If docs where tree vs graph we would probably have at least some orgs doing it right, while there are literarily almost zero.

    Some of the important aspects of good documentation is:

    1. Narrative style. You can't do ad hoc whatever wherever and call it a day. Most people don't have it and many are quite illiterate IMO. You need to practice this and most engineers don't like that. Hell, even most seniors don't like writing tickets IME which take almost the same time as putting garbage on Slack. I created templates on both GH and GL and almost nobody uses them even tho you don't need to think about anything but follow few rules.

    2. Its quite hard to know what level of detail to put in documentation. You need a lot of experience for this - put to much, and it gets quickly outdated, put too little, and it doesn't convey much. Good documentation exists on multiple levels - as bunch of markup files "on the spot", as formal hi and low level documentation and also those are usually affecting different target groups so you actually need to design docs.

    3. Documentation is a service. It has source code, build procedure, automatic link checking, export to bunch of format, crosslinks, variables, macros, configuration for different environments, abbreviations, definitions. Its quite hard to get it right. After years of struggle on different projects I finally created my own stuff [1] that I use on all projects, for docs spanning 50-500 pages. I maintain that for years now, constantly (so yeah, its a job).

    [1]: https://github.com/majkinetor/mm-docs-template

Stats

Basic mm-docs-template repo stats
1
9
6.1
8 months ago

Sponsored
Nutrient - The #1 PDF SDK Library
Bad PDFs = bad UX. Slow load times, broken annotations, clunky UX frustrates users. Nutrient’s PDF SDKs gives seamless document experiences, fast rendering, annotations, real-time collaboration, 100+ features. Used by 10K+ devs, serving ~half a billion users worldwide. Explore the SDK for free.
nutrient.io

Did you know that PowerShell is
the 40th most popular programming language
based on number of references?