Skip to content

build: markdown-to-html rule should apply docs-specific transforms #14315

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

Conversation

devversion
Copy link
Member

Currently when building the overview and guide files with Bazel, the following things are missing:

  • Replacing <!-- example comments with the corresponding HTML elements
  • Wrapping the HTML output with a <div class="docs-markdown"> element
  • Rewriting relative links to the proper public guide URL.
  • Convert headings to "anchored" headings that can be referenced through URL fragments.

All of these points are handled with this commit.

Note: These points are taken from our current docs gulp task, but I removed some Regex transforms and just extended the default Markdown renderer to make these changes like they're supposed to.

@devversion devversion added pr: merge safe target: patch This PR is targeted for the next patch release labels Nov 28, 2018
@devversion devversion requested a review from jelbourn as a code owner November 28, 2018 19:56
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Nov 28, 2018
@devversion devversion force-pushed the build/markdown-html-bazel-docs-specific-transformations branch from 844efab to 66dc9bf Compare November 28, 2018 19:57
Currently when building the overview and guide files with Bazel, the following things are missing:

* Replacing `<!-- example` comments with the corresponding HTML elements
* Wrapping the HTML output with a `<div class="docs-markdown">` element
* Rewriting relative links to the proper public guide URL.
* Convert headings to "anchored" headings that can be referenced through URL fragments.

All of these points are handled with this commit.
@devversion devversion force-pushed the build/markdown-html-bazel-docs-specific-transformations branch from 66dc9bf to 551b6a7 Compare November 28, 2018 20:26
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

@jelbourn
Copy link
Member

Lint error

ERROR: /home/circleci/ng/tools/markdown-to-html/docs-marked-renderer.ts[26, 41]: 'raw' is declared but its value is never read.

@devversion devversion added the action: merge The PR is ready for merge by the caretaker label Nov 28, 2018
@devversion
Copy link
Member Author

Fixed @jelbourn

@jelbourn jelbourn merged commit bd9645e into angular:master Nov 29, 2018
jelbourn pushed a commit that referenced this pull request Dec 3, 2018
…14315)

Currently when building the overview and guide files with Bazel, the following things are missing:

* Replacing `<!-- example` comments with the corresponding HTML elements
* Wrapping the HTML output with a `<div class="docs-markdown">` element
* Rewriting relative links to the proper public guide URL.
* Convert headings to "anchored" headings that can be referenced through URL fragments.

All of these points are handled with this commit.
josephperrott pushed a commit to josephperrott/components that referenced this pull request Jan 14, 2019
…ngular#14315)

Currently when building the overview and guide files with Bazel, the following things are missing:

* Replacing `<!-- example` comments with the corresponding HTML elements
* Wrapping the HTML output with a `<div class="docs-markdown">` element
* Rewriting relative links to the proper public guide URL.
* Convert headings to "anchored" headings that can be referenced through URL fragments.

All of these points are handled with this commit.
@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 10, 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 target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants