kit-doc
kit-doc

edge

kit-doc edge

MarkdownPreprocessor module
Kit::Doc::Services::MarkdownPreprocessor
View Source

Basic markdown preprocessing.

Adds variable substitution when generating Kit::Doc documentation, while staying compatible with Github markdown previews.

This is particularly helpful for versionned link references in Guides.

Link to this section Summary ⚠️ Private APIs are currently hidden.

Defined in: lib/kit/doc/services/markdown_preprocessor.rb#9

Class methods 2

.preproc_conditionals(content:, variables:, preproc_regex: PREPROC_REGEX)

Replace static content: by dynamic one hidden in html comments.
.preproc_variables(content:, variables: {}, variables_regex: VARIABLES_REGEX)

Replace variables name patterns identified with `variables_regex` with values from `variables` hash in `content:`.

Constants 2

PREPROC_REGEX

Simple regex to identify preprocessing comments.
VARIABLES_REGEX

Simple regex to identify `$variable_name` patterns.

Link to this section Class methods 2

Link to this method

.preproc_conditionals(content:, variables:, preproc_regex: PREPROC_REGEX)

View Source

Replace static content: by dynamic one hidden in html comments.

Also calls preproc_variables to resolve dynamic values in preprocessing comments.

Examples 

irb> preproc_conditionals({
  content:   <<~TEXT,
    <!--pp -->
    [Doc - GitHub Link](https://docs.rubykit.org/kit/edge)
    <!-- { [Doc - Kit Link](https://docs.rubykit.org/kit/$VERSION) } pp-->
  TEXT
  variables: { VERSION: 'v0.1.0' }
})
[:ok, processed_content: '[Doc - Kit Link](https://docs.rubykit.org/kit/v0.1.0)']
Link to this method

.preproc_variables(content:, variables: {}, variables_regex: VARIABLES_REGEX)

View Source

Replace variables name patterns identified with variables_regex with values from variables hash in content:.

Examples 

irb> preproc_variables({
  content:   'Current version is $version!',
  variables: { version: 'v0.1.0' }
})
[:ok, processed_content: 'Current version is v0.1.0!']

Link to this section Constants 2

Link to this constant

PREPROC_REGEX

View Source

Simple regex to identify preprocessing comments.

Examples 

<!--pp -->
[Doc - GitHub Link](https://docs.rubykit.org/kit/edge)
<!-- { [Doc - Kit Link](https://docs.rubykit.org/kit/$VERSION) } pp-->

Will generate a match from `<!--pp` to `pp-->`,
  with the content inside `{}` captured in a group named `prepoc_content`:

[Doc - Kit Link](https://docs.rubykit.org/kit/$VERSION)

The regex simply match