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

Support rst files #206

Open
linawolf opened this issue Jul 24, 2024 · 2 comments
Open

Support rst files #206

linawolf opened this issue Jul 24, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@linawolf
Copy link

I wonder if it was possible to support rst files and maybe use our rst parser for that: https://github.com/phpDocumentor/guides

@andreaswolf
Copy link
Owner

That would definitely be possible, we just never thought of that.

Do you have an example usecase that we could use to kickstart this? @linawolf

@linawolf
Copy link
Author

For example we could add link anchors to all headlines that do not have one yet for consistent links when a headline is renamed.

https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/ReStructuredText/Content/Links.html#explicit-link-targets

And we could sluggify those link anchors so they are always written the way that the phpdocumentor/guides interprets them (all lowercase, special chars replaced by hyphen etc)

@simonschaufi simonschaufi added the enhancement New feature or request label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants