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

api: UI improvements #1028

Closed
3 tasks
jorgeorpinel opened this issue Feb 27, 2020 · 1 comment
Closed
3 tasks

api: UI improvements #1028

jorgeorpinel opened this issue Feb 27, 2020 · 1 comment
Labels
type: enhancement Something is not clear, small updates, improvement suggestions website: design Website graphic design website: eng-doc DEPRECATED JS engine for /doc

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Feb 27, 2020

Emanates from #908

  • Support ```py Markdown highlighter (code blocks)

  • Automatic link to function names in back quotes (similar to command names) to their api ref. Eg. `dvc.api.read()` -> /doc/api-reference/read

  • (maybe) special CSS for first <h3> (###) in api ref pages, currently used as title No longer needed, see api: create docs #908 (comment).

  • Better way to show what literals in example code blocks evaluate to. Currently print() is used in the block, then a --- (<hr>) and a following block quote (```dvc) shows what the output of running the script would do:
    image

@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions website: eng-doc DEPRECATED JS engine for /doc website: design Website graphic design labels Feb 27, 2020
@jorgeorpinel jorgeorpinel mentioned this issue Feb 27, 2020
1 task
@shcheklein
Copy link
Member

Closing in favor of #910 ... everything else is solved more or less I believe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Something is not clear, small updates, improvement suggestions website: design Website graphic design website: eng-doc DEPRECATED JS engine for /doc
Projects
None yet
Development

No branches or pull requests

2 participants