juliadocs / documentermarkdown.jl Goto Github PK

Let's say I have a block in my files within the src folder, something like

index.md

!!! info
    This is import information 

then when I do

makedocs(..., format = Markdown(), build = "docs")

this outputs a new file into docs where the syntax is the same (good)

!!! info
    This is import information

but if I do

index.md

??? info
    This is import information 

then I get

??? info This is import information

which is not good. I'm trying to have collapsible blocks (like the ones here but collapsible).
And in order to get them, I would need to have as output in my docs folder:

??? info
    This is import information

any hints on how to solve this?

I have this problem when using DocumenterMarkdown.

If we have a block of several docstrings like this:

```@docs
Base.Function1
Base.Function2
```
Some text outside of macro.

then in the output we will get something like this:

<a id='Base.Function1' href='#Base.Function1'>#</a>
**`Base.Function1`** &mdash; *Function*.

Docstring text for Function1

<a id='Base.Function2' href='#Base.Function2'>#</a>
**`Base.Function2`** &mdash; *Function*.

Docstring text for Function2

Some text outside of macro.

The problem is that we don't have any separator between the end of docstring text and the next text. Because of that it is difficult to further isolate the docstring texts on this page (if we want to convert it to some other format and maybe to make some highlighting for every separate docstring - for example add frames to them).

It would be great to have something like this in the output:

<a id='Base.Function1' href='#Base.Function1'>#</a>
**`Base.Function1`** &mdash; *Function*.

Docstring text for Function1

[//]: # (End of docstring)

<a id='Base.Function2' href='#Base.Function2'>#</a>
**`Base.Function2`** &mdash; *Function*.

Docstring text for Function2

[//]: # (End of docstring)

Some text outside of macro.

Or any other type of separators (horizontal line, some html tag etc.)

When user copy button the $(Doller) sign also get copied.

Are there plans to update this package for Documenter 1.0?

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!