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
```bash
$ pip install foliantcontrib.customids
```
## Usage
To apply a preprocessor add it's name to a preprocessor list in `foliant.yaml` config file, e.g.:
```yaml
preprocessors:
- 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.
```markdown
# 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:
```
http://.../index.html#custom_id
```
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
```bash
$ pip install foliantcontrib.customids
```
## Usage
To apply a preprocessor add it's name to a preprocessor list in `foliant.yaml` config file, e.g.:
```yaml
preprocessors:
- 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.
```markdown
# 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:
```
http://.../index.html#custom_id
```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for foliantcontrib.customids-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 340501ee0d494510b7c29158092aaa8e1195bf6be3f35501e289414704ee2fd9 |
|
MD5 | ce3b871950d1c42d0178a4c6824888c1 |
|
BLAKE2b-256 | ae6fd8845e77b4f7987ee6be740f7c1309208157e1793fb45a1bf5290f59b0bf |