Just a FYI when people start trying to submit bugs about this, mobx-react shipped a funky build which is causing broken-ness (at least when using redoc-cli bundle)

mobxjs/mobx-react#831

Currently breaks with an error like:
Cannot find module '..../.npm/_npx/1868/lib/node_modules/redoc-cli/node_modules/mobx-react/dist/mobxreact.js (added for searchability)

Can

Hi;

I hope it's a feature request and not a bug report
I try to apply design.background but at the item level
and the code won't let me add more than one [design.background]

this is work

widget = "slider"
weight = 11
[[item]]
  title = "Left"
  content = "I am left aligned :smile:"
  [design.background]
    gradient_start = "#0000F9"
    gradient_end = "#86007D"

I'm new to rest_framework but I'm using drf in combination with redoc and this library and it seems to work fantastic.

I was wondering how can I generate custom sections of the documentation for objects that are commonly reused across all API calls. For example, I have a token object that is query/post parameter so I would like this to be explained topic in its own section.

With the help of

hi there, in my package.json I have

... 
"build:utils": "jsdoc2md --files ./resources/assets/jsx/app/utils/*.ts* --configure ./jsdoc2md.json > ./resources/assets/jsx/docs/utils.md",

if I run by shell (MacOS, jsdoc2md v5.0.0)

$ jsdoc2md --files ./resources/assets/jsx/app/utils/*.ts* --configure ./jsdoc2md.json > ./resources/assets/jsx/docs/utils.md

all works fine,

If a public type is named Home, _Sidebar, or _Footer, its generated documentation would be overwritten by the special page of the same name. We should add logic in the generate subcommand to handle this possibility.

It would be good to generate documentation with schemas that has federation support.
Reference https://www.apollographql.com/docs/apollo-server/federation/introduction/

For example, the following federated query fails to generate document

extend type Query {
  me: User
}

type User @key(fields: "id") {
  id: ID!
  username: String!
}

error message:

Must provide schema

I was wondering if you guys would consider adding support for https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-transformer-documentationjs

That would make Hasura the perfect starter for almost any library that uses JSDocs which is probably almost all of them. All any dev would need to do is create the new starter inside the lib and you get instant perfect documentation autogenerat

Expected Behavior

A way to include the --http mode's "Python module list" index.html as the root index.html of the --html output.

Actual Behavior

By default, there is no index.html at the top level of the HTML output. There doesn't seem to be a way to enabl

My gorilla mux routes are set up using controllers so that each route has access to the app's runtime, which contains important config variables.

The handlers on the controller have a similar signature as the ones provided in the repo's example by accepting http.ReponseWriter and *http.Request as arguments with no return value. The only difference is that it's registered as methods on the

Hi everyone

I'm in the process of trying to use Documenter to document a medium sized project.

I've written plenty of technical reference material in the past (a lot in the form of function docstrings). But that's is only one aspect of good documentation and I'm somewhat of a novice in structuring the other parts.

In that respect, I've found the following blog post extremely helpful in

Swagger supports the deprecated flag on paths, see https://swagger.io/docs/specification/paths-and-operations/. Would be good to be able to have this carry over in the AWS documentation.

This would look something like:

createItem:
  handler: handler.create
  events:
    - http:
        path: create
        method: post
        documentation:
          summary: "Create something"
 

Hi Vladimir,
first of all thanks for supplying your tools as open source! I was searching for anything to document lua code taking doxygen as base, which I am used to for C++ documentation. Currently I am in the stage of getting known to your tools in a better way and try to do that with a simple lua module file (Please see init.lua inside simpleSetModule folder in attached zipped file).

Brief Description

Steps to Reproduce

Extend a type to conform to a protocol.

Expected Outcome

The generated extension documentation ought to allude to protocol conformance. Even better, it should live in the same file as the generated class documentation, while

Hello @NiklasRosenstein,

I like this library a lot, I find it so useful. Though, I would like to be able to include images in both README.md and index.md. Let me explain:

PROBLEM

• Let say README.md is at the project's root, as usually.
• I have a folder named sources, which is also specified at the pydocmd.yml as docs_dir: sources.
• Finally, I specify
  `pages: - Home: index.m

This program is super useful! I have built it in to my git pre-commit hook so that it runs before every commit, but that means every single time I have to wait for the search index to "update" even when I haven't made any changes to the documentation.

It would be really cool to build in a functionality that the full program would only run if the documentation had changed. For instance, you co

This is more of a request / question. I'd like to know if this added feature is something that could be incorporated into Literate, or if it's better for Documenter, or just create a separate package.

The gist of the feature (pages_array) is that the nes

Is there a way to document just functions?

/**
 * This is my func.
 */
export const myFunc = () => {};

Currently the documentation is avaible: https://api.haxe.org/haxe/ds/UnsafeStringMap.html
But not the class if you click on View Sources: https://github.com/HaxeFoundation/haxe/blob/4.0.5/std/haxe/ds/UnsafeStringMap.hx

It should point to: https://github.com/HaxeFoundation/haxe/blob/development/std/flash/_std/haxe/ds/UnsafeStringMap.hx ?

when field name are a bit long there can happen they overlaps between field and type
see here below the image png produced by the dot
this is caused by the font override ( helvetica ) that takes much space
so if is not possible to compute the font aprior could helpful add together font family override another factor to do right adjustment.

(original font)
![test2](https://cloud.githubusercontent.