gitbook-plugin-css-passenger

0.1.0 • Public • Published

gitbook-plugin-css-passenger

Transmit css passenger to the destination.

Install

By npm:

npm install gitbook-plugin-css-passenger

By gitbook-cli:

gitbook install css-passenger

Usecases

When you writing a "table" under Gitbook, you may like this:

| Name | Description | Example |
| :---: | --- | --- |
| context1 | description of context1 | Something very long long long long long long long long long long long long long long long long long ... |
| context2 | description of context2 | Something very long long long long long long long long long long long long long long long long long ... |
| context3 | description of context3 | Something very long long long long long long long long long long long long long long long long long ... |

The result may be look like this:

Name Description Example
context1 description of context1 Something very long long long long long long long long long long long long long long long long long ...
context2 description of context2 Something very long long long long long long long long long long long long long long long long long ...
context3 description of context3 Something very long long long long long long long long long long long long long long long long long ...

If you want the words in "Description" column not be automatic wrapped, How to?

CSS properties white-space: nowrap; may be help, you can write in your global css file:

table tbody tr td:nth-child(2) {
    white-space: nowrap;
}

In this case the second column need to be wrapped, in another case it's not certain which column. Ii't a problem.

Then our plugin help you. Since markdown syntax support embedded HTML, we can give a "empty" element to the writing, now you can write like this:

<div class="css-passenger" data-class="nw2"></div>

| Name | Description | Example |
| :---: | --- | --- |
| context1 | description of context1 | Something very long long long long long long long long long long long long long long long long long ... |
| context2 | description of context2 | Something very long long long long long long long long long long long long long long long long long ... |
| context3 | description of context3 | Something very long long long long long long long long long long long long long long long long long ... |

The <div> is not display. But it's attribute data-class will pass to the next element as className. Now using Browser's developer-tools, you can fing the table has one more className "nw2". That's what the plugin done.

Our style file let table.nw2 's second column not be wrapped. Else if you want other column not be wrapped too, just add more class:

<div class="css-passenger" data-class="nw1 nw2"></div>

<div class="css-passenger" data-class="nw1 nw2 nw3"></div>

...

Readme

Keywords

Package Sidebar

Install

npm i gitbook-plugin-css-passenger

Weekly Downloads

1

Version

0.1.0

License

MIT

Last publish

Collaborators

  • yuhenabc