Skip to content

build(docs): markdown for api descriptions #4689

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

Merged
merged 1 commit into from
May 22, 2017

Conversation

devversion
Copy link
Member

  • Parses Class, Property and Method descriptions using a markdown filter from Dgeni.

Important: Markdown adds <p> elements around text and those have margins by default. The styles on material.angular.io would need to be revised too.

But still a big benefit because backticks are rendered as code snippets. Same would happen if there would be multi line code-snippets.

Closes #3924

* Parses Class, Property and Method descriptions using a markdown filter from Dgeni.

Closes angular#3924
@devversion devversion requested a review from jelbourn May 19, 2017 22:37
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label May 19, 2017
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Feel free to send a corresponding PR to the docs repo for the css if you want

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker and removed pr: needs review labels May 19, 2017
@tinayuangao tinayuangao merged commit 7f4516a into angular:master May 22, 2017
@devversion devversion deleted the build/api-markdown branch May 22, 2017 18:38
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support markdown in source code docs
4 participants