Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guides output dir and searchability question #3406

Open
SQKo opened this issue Dec 11, 2022 · 1 comment
Open

Guides output dir and searchability question #3406

SQKo opened this issue Dec 11, 2022 · 1 comment

Comments

@SQKo
Copy link

SQKo commented Dec 11, 2022

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:

  1. 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.
  2. 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?
  3. 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
  4. Table borders, it's weird to have table without any borders.
  5. Also how do I embed image from external link?

Thank you.

@phpdoc-bot phpdoc-bot added this to Needs triage in phpDoc issue triage board Dec 11, 2022
@jaapio
Copy link
Member

jaapio commented Mar 14, 2023

Thanks for your message, I'm glad to hear that you like the new feature :-)

  1. 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.
  2. 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.
  3. 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.
  4. You can overwrite the CSS https://docs.phpdoc.org/latest/guide/features/theming/custom-styling.html#custom-styling, hope this will help you.
  5. you cannot embed external images right now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
phpDoc issue triage board
  
Needs triage
Development

No branches or pull requests

2 participants