-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Feature request: rewrite index.html files in README.md format #4
Comments
It will be hard to support two versions of documentation. We need to think how to make it optimal. |
How is the documentation generated? It looks like doxygen is used (some |
It seems GitHub can render .rst file format as well. oneTBB is moving in this direction. So, this will be automatically covered. Therefore, I think the issue can be closed. Interested people could reopen it if they deem useful. |
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
GitHub does not show index.html as directory description and reading index.html files is hard in plain text.
Markdown (.md) syntax is clean for direct reading (and maintaining!) and also converts easily to .html preserving all the formatting features.
E.g. online converter is here: https://pandoc.org/try/?text=&from=html&to=markdown_github
The text was updated successfully, but these errors were encountered: