A markitdown plugin for converting Scrapbox notation to Markdown
Project description
markitdown-cosense
A markitdown plugin for converting Scrapbox notation to Markdown.
Features
This plugin converts various Scrapbox notations to standard Markdown format:
- Headings:
[* Heading]→# Heading - Text decorations:
[/ italic],[- strikethrough],[** bold] - Lists: Indented lines with spaces, tabs, or full-width spaces
- Code blocks:
code:languagenotation - Tables:
table:namenotation - Links and images:
[title url],[img url] - Math expressions:
[$ formula $]→$formula$ - LaTeX blocks:
code:texwith mathematical content
Installation
pip install markitdown-cosense
Usage
With markitdown CLI
# List available plugins
markitdown --list-plugins
# Convert a file using the plugin
markitdown --use-plugins your-file.txt
Programmatic usage
from markitdown import MarkItDown
from markitdown_cosense import register_converters
# Initialize markitdown
md = MarkItDown()
# Register the converter
register_converters(md)
# Convert a file
result = md.convert("your-scrapbox-file.txt")
print(result.text_content)
Features
- Converts Scrapbox notation to standard Markdown
- Handles headings, formatting, links, images, lists, tables, code blocks, and math notation
- Converts tags
[tag]to HTML comments<!-- tag: tag -->to preserve information while maintaining valid Markdown
Examples
Input (Scrapbox notation)
[* Project Title]
[** Overview]
This project is about [/ converting] Scrapbox notation.
Features:
Main feature
Sub feature 1
Sub feature 2
Another feature
code:python
def hello():
print("Hello, World!")
table:Results
Name Score Grade
Alice 95 A
Bob 87 B
Output (Markdown)
# Project Title
## Overview
This project is about *converting* Scrapbox notation.
Features:
- Main feature
- Sub feature 1
- Sub feature 2
- Another feature
```python
def hello():
print("Hello, World!")
Results
| Name | Score | Grade |
|---|---|---|
| Alice | 95 | A |
| Bob | 87 | B |
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file markitdown_cosense-0.1.0.tar.gz.
File metadata
- Download URL: markitdown_cosense-0.1.0.tar.gz
- Upload date:
- Size: 8.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
145c77655869af250793f78783073aa7b8290d8df2cda6d8068f33f5f2892a98
|
|
| MD5 |
d42a3564de88170af76395992eb50a02
|
|
| BLAKE2b-256 |
ab2d838caa65e3876c9e55ff86d05127d1030ad4b6c255d9070c79f49072d905
|
Provenance
The following attestation bundles were made for markitdown_cosense-0.1.0.tar.gz:
Publisher:
publish.yml on kazu728/markitdown-cosense
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
markitdown_cosense-0.1.0.tar.gz -
Subject digest:
145c77655869af250793f78783073aa7b8290d8df2cda6d8068f33f5f2892a98 - Sigstore transparency entry: 264743143
- Sigstore integration time:
-
Permalink:
kazu728/markitdown-cosense@d030b91be53d2bbb107383e7048bb76bc1874ae6 -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/kazu728
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@d030b91be53d2bbb107383e7048bb76bc1874ae6 -
Trigger Event:
release
-
Statement type:
File details
Details for the file markitdown_cosense-0.1.0-py3-none-any.whl.
File metadata
- Download URL: markitdown_cosense-0.1.0-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
585dd5b1b3e01d860d01c27a8534baefaed7fdd28c3bdb6834076f1680c4db86
|
|
| MD5 |
1c97338670e7a061bc653b79fc99ec1c
|
|
| BLAKE2b-256 |
56387d5317e9381d54f24d4a142c63c84084512c92f315ac137b7d6664d67692
|
Provenance
The following attestation bundles were made for markitdown_cosense-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on kazu728/markitdown-cosense
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
markitdown_cosense-0.1.0-py3-none-any.whl -
Subject digest:
585dd5b1b3e01d860d01c27a8534baefaed7fdd28c3bdb6834076f1680c4db86 - Sigstore transparency entry: 264743145
- Sigstore integration time:
-
Permalink:
kazu728/markitdown-cosense@d030b91be53d2bbb107383e7048bb76bc1874ae6 -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/kazu728
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@d030b91be53d2bbb107383e7048bb76bc1874ae6 -
Trigger Event:
release
-
Statement type: