Skip to content
#

documentation-generator

Documentation is a set of information that describes a product to its users, including what it is, how it operates, and how to use it.

Here are 573 public repositories matching this topic...

jorisvanzundert
jorisvanzundert commented May 8, 2019

Hi,

(Apologies for being a bit verbose.)

Is it possible to have section headers in the sidebar that are links to section anchors? Thus, section headers that point to e.g. "/mybook/chapter_002#a-particular-section. (Each # header in .md becomes an anchor.)

I tried a workaround by using simply external: true, but this fails because _prepare_toc() errors out on the hashtag. Besid

webjunkie
webjunkie commented Aug 24, 2018

I'm using https://github.com/Artory/drf-hal-json/ that basically provides custom base serializers that add dynamically fields like _links into the response via the to_representation method.

I tried to somehow get that into the schema as well, but I'm getting stuck. Are there any directions on what I need to provide/subclass/overwrite, so to make it work?

I imagine I could inspect my seri

log4brains
NiklasRosenstein
NiklasRosenstein commented Jun 14, 2020

You can have two API objects that use the same anchor reference. When both are rendered into the same Markdown file, the references are not unique, and one of the links will not work.

def a():
  """ Links to [a][0].

  [0]: https://a.org """

def b():
  """ Links to [b][0].

  [0]: https://b.org """

The MarkdownRenderer should find such duplicate references (here 0 an

Wikipedia
Wikipedia