You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hello, I've been using the guide feature, I'm happy because I can put hand written docs in the same place for the generated docs (it's also reduce confusion to readers). I'm aware that it's still experimental, but I have question about:
The output dir, I'd like to set the hand written docs in the root path instead of being in sub directory, i tried to adjust it from the configuration but no luck. This may be no issue for those who host the docs in web servers, but not for those who host the docs in github pages since it's almost impossible to make redirect rule.
Search function, the search in phpDocumentor seems do not look up results for the hand written guides, not sure if I need to set up something for that?
Markdown support, it is mentioned in https://docs.phpdoc.org/3.0/guide/hand-written-docs/index.html that Markdown is supported, but i looked again here it's still work in progress, i hope that can happen soon since I'm not familiar writing with reStructuredText, the syntax is not that easy and external tools out there requires me to set up Python, they are mostly for writing Sphinx docs, so that I'm not sure the syntax will be even understood by phpDocumentor, not just that, the syntax is not friendly with php codes, like i have to escape every underscore when mentioning a php snake case variables
Table borders, it's weird to have table without any borders.
Also how do I embed image from external link?
Thank you.
The text was updated successfully, but these errors were encountered:
Thanks for your message, I'm glad to hear that you like the new feature :-)
right now there is no way to change that, the internals of our project are not able to do that right now. Which is a but unfortunate. We want to be able to make this support better, but it requires quite a lot of changes. I have been working on this in WIP: Project builder improvements #2837 but there were so many things that need to be solved first, that I'm not able to promise anything about when and how this feature will land.
The guides are not part of the search at the moment. We will include them at some point. We are still working on the parser to get everything right. Search is a less important feature right now. But they will be part of the search at some moment.
Markdown is the next step, we first want to focus on RST as that's the most promising format. Markdown is a bit too limited in what we want.
Hello, I've been using the guide feature, I'm happy because I can put hand written docs in the same place for the generated docs (it's also reduce confusion to readers). I'm aware that it's still experimental, but I have question about:
Thank you.
The text was updated successfully, but these errors were encountered: