markdown-blockifier-default

Converts Markdown text into Steamship format. Markdown elements are transformed into Steamship Tags for querying.

Using

Tagger Plugins add annotations to text that can be queried and composed later.

Blockifiers convert data into Steamship’s native Block format.

Importer Plugins add annotations to text that can be queried and composed later.

Use them when writing Packages to help you work with data of different types.

Links

from steamship import Steamship, File

client = Steamship(workspace="my-workspace-handle")

# Import a file to Steamship
with open("file.ext") as f:
  file = File.create(content=file.read())

# Create an instance of this blockifier
blockifier = client.use_plugin(
  'markdown-blockifier-default'
)

# Blockify the file
task = file.blockify()
task.wait()
from steamship import Steamship, File

client = Steamship(workspace="my-workspace-handle")

# Import a file to Steamship
with open("file.ext") as f:
  file = File.create(content=file.read())

# Create a blockifier. We'll assume Markdown here.
blockifier = client.use_plugin(
  'markdown-blockifier-default'
)

# Blockify the file
task = file.blockify()

# Create an instance of this tagger.
tagger = client.use_plugin(
  'markdown-blockifier-default'
)

# Tag the file
task = file.tag()

task.wait()
Pulled from the GitHub repository.
# markdown-blockifier-default Blockifier Plugin - Steamship

This project documents a Steamship Blockifier plugin that converts Markdown text into Steamship format.

This repository is documentation only: this particular plugin is built in to the Steamship Engine directly.

## Usage

```python

from steamship import Steamship, File, MimeTypes

client = Steamship()

file = File.create(client, markdown_content, mime_type=MimeTypes.MKD)
blockifier = client.use_plugin("markdown-blockifier-default")
task = file.blockify(blockifier.handle)
task.wait()

```

## Input

The input should be a file whose content is Markdown text.

## Output

The output is one Steamship Block per block element of markdown, along with tags for span elements:

The list of tags used are those in the `DocTag` class
[defined in the Steamship Python Client](https://github.com/steamship-core/python-client/blob/main/src/steamship/data/tags/tag_constants.py#L23)

Steamship is building the fastest way to ship language AI.

Stop building and start shipping. Reach out to get onboarded.
Read More