معرفی شرکت ها

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

توضیحات

Badges for Foliant.

ویژگی	مقدار
سیستم عامل	-
نام فایل	foliantcontrib.badges-1.0.4
نام	foliantcontrib.badges
نسخه کتابخانه	1.0.4
نگهدارنده	[]
ایمیل نگهدارنده	[]
نویسنده	Daniil Minukhin
ایمیل نویسنده	ddddsa@gmail.com
آدرس صفحه اصلی	https://github.com/foliant-docs/foliantcontrib.badges
آدرس اینترنتی	https://pypi.org/project/foliantcontrib.badges/
مجوز	MIT

[![](https://img.shields.io/pypi/v/foliantcontrib.badges.svg)](https://pypi.org/project/foliantcontrib.badges/) [![](https://img.shields.io/github/v/tag/foliant-docs/foliantcontrib.badges.svg?label=GitHub)](https://github.com/foliant-docs/foliantcontrib.badges) # Badges Preprocessor for Foliant which helps to add badges to your documents. It uses [Shields.io](https://shields.io) to generate badges. # Installation ```bash $ pip install foliantcontrib.badges ``` # Config To enable the preprocessor, add `badges` to `preprocessors` section in the project config: ```yaml preprocessors: - badges ``` The preprocessor has a number of options: ```yaml preprocessors: - badges: server: 'https://img.shields.io' as_object: true add_link: true vars: jira_path: localhost:3000/jira package: foliant # badge look parameters style: flat-square logo: jira ``` `server` : Shields server URL, which hosts badges. default: `https://img.shields.io` `as_object` : If `true` — preprocessor inserts `svg` badges with HTML `<object>` tag, instead of Markdown image tag. This is required for links and hints to work. default: `true` `add_link` : If `true` preprocessor tries to determine the link which should be added to badge (for example, link to jira issue page for jira issue badge). Only works with `as_object = true`. default: `true` > Please note that right now only links for **pypi** and **jira-issue** badges are being added automatically. Please contribute or contact author for adding other services. `vars` : Dictionary with variables which will be replaced in badge urls. See **variables** section. Also you may add parameters specified on the shields.io website which alter the badge view like: `label`, `logo`, `style` etc. # Usage Just add the `badge` tag and specify path to badge in the tag body: ``` <badge>jira/issue/https/issues.apache.org/jira/kafka-2896.svg</badge> ``` All options from config may be overriden in tag parameters: ``` <badge style="social" as_object="false">jira/issue/https/issues.apache.org/jira/kafka-2896.svg</badge> ``` ## Variables You can use variables in your badges to replace parts which repeat often. For example, if we need to add many badges to our Jira tracker, we may put the protocol and host parameters into a variable like this: ```yaml preprocessors: - badges: vars: jira: https/issues.apache.org/jira ``` To reference a variable in a badge path use syntax `${variable}`: ``` <badge>jira/issue/${jira}/kafka-2896.svg</badge> Description of the issue goes here. But it's not the only one. <badge>jira/issue/${jira}/KAFKA-7951.svg</badge> Description of the second issue. ```

نیازمندی

مقدار	نام
>=1.0.8	foliant
>=1.0.2	foliantcontrib.utils

نحوه نصب

نصب پکیج whl foliantcontrib.badges-1.0.4:

pip install foliantcontrib.badges-1.0.4.whl

نصب پکیج tar.gz foliantcontrib.badges-1.0.4:

pip install foliantcontrib.badges-1.0.4.tar.gz