Skip to main content

Custom heading IDs for Foliant.

Project description

# Сustom heading ID's for Foliant

CustomIDs preprocessor lets user define custom identifiers for each heading. These custom ID's can be used later to create short links to a specific parts of any page.

## Installation

$ pip install foliantcontrib.customids

## Usage

To apply a preprocessor add it's name to a preprocessor list in `foliant.yaml` config file, e.g.:

- customids

Custom ID must be written after heading on the same line in curly brackets. Custom ID must not contain spaces and shoud be written using latin symbols.

# Heading 1 {custom_id_for_first_heading}

Some text goes here.

## Heading 2 {custom_id_for_second_heading}

Some more text

Custom ID will replace long slug which is created automatically when building a site. Resulting URL when using custom ID will look like this:


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

foliantcontrib.customids-1.0.0.tar.gz (2.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page