Skip to content

docs: custom marked formatter for lead-in blockquotes #3031

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 9 commits into from
Apr 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Changelog

All notable changes to this project will be documented in this file. See
[standard-version](https://github.com/conventional-changelog/standard-version) for commit
guidelines.
> All notable changes to this project will be documented in this file. See
> [standard-version](https://github.com/conventional-changelog/standard-version) for commit
> guidelines.

<a name="2.0.0-rc.15"></a>

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍
> 👍🎉 First off, thanks for taking the time to contribute! 🎉👍

## Playground & Issue Reports

Expand Down
2 changes: 2 additions & 0 deletions docs/markdown/misc/settings/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Settings

> BootstrapVue provides a few options for customizing component default values, and more.

## Configuring BootstrapVue defaults

BootstrapVue is pre-configured for the default Bootstrap V4.x configuration. It assumes the
Expand Down
4 changes: 2 additions & 2 deletions docs/markdown/reference/theming/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Theming Bootstrap & BootstrapVue

Theming is accomplished by Sass variables, Sass maps, and custom CSS. There’s no dedicated theme
stylesheet; instead, you can enable the built-in theme to add gradients, shadows, and more.
> Theming is accomplished by Sass variables, Sass maps, and custom CSS. There’s no dedicated theme
> stylesheet; instead, you can enable the built-in theme to add gradients, shadows, and more.

While BootstrapVue uses Bootstrap's CSS, certain features of BootstrapVue uses custom CSS (i.e.
stacked tables, etc). Our custom CSS relies on variables defined the Bootstrap V4.x SCSS. The
Expand Down
4 changes: 2 additions & 2 deletions docs/markdown/reference/validation/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Form Validation

BootstrapVue does not include form validation by default; we leave that up to the many existing form
validation plugins. Below are some examples of plugins and how they may be integrated.
> BootstrapVue does not include form validation by default; we leave that up to the many existing
> form validation plugins. Below are some examples of plugins and how they may be integrated.

## Vuelidate

Expand Down
5 changes: 5 additions & 0 deletions docs/nuxt.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ renderer.heading = function(text, level, raw, slugger) {
return `<h${level} id="${link}">${getTextMarkup(text + anchor)}</h${level}>\n`
}

// Convert lead-in blockquote paragraphs to true bootstrap docs leads
renderer.blockquote = function(text) {
return text.replace('<p>', '<p class="bd-lead">')
}

// BS4 table support for markdown renderer
const originalTable = renderer.table
renderer.table = function(header, body) {
Expand Down
2 changes: 1 addition & 1 deletion src/components/collapse/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Collapse

toggle content visibility on your pages. Includes support for making accordions.
> Esily toggle content visibility on your pages. Includes support for making accordions.

```html
<div>
Expand Down
4 changes: 2 additions & 2 deletions src/components/table/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Tables

> For displaying tabular data. `<b-table>` supports pagination, filtering, sorting, custom
> rendering, events, and asynchronous data.
> For displaying tabular data, `<b-table>` supports pagination, filtering, sorting, custom
> rendering, various style options, events, and asynchronous data.

**Example: Basic usage**

Expand Down