Skip to main content

Add the content type attribute to AsciiDoc files.

Project description

AsciiDoc Content Type Editor

content-type-editor is a web user interface that allows the user to add the _mod-docs-content-type attribute to a large number of AsciiDoc files that follow the guidelines for modules as defined in the Modular Documentation Reference Guide. If the content type can be reliably recognized from the file name or its contents, it provides it as a suggestion which the user can apply. If the content type is ambiguous, it displays analysis of the module content to help the user make the correct choice.

A demo of the AsciiDoc Content Type Editor workflow

Installation

Install the content-type-editor Python package:

python3 -m pip install --upgrade content-type-editor

Usage

Navigate to the directory with your AsciiDoc project and run the following command:

content-type-editor

Alternatively, you supply the path to the project directory on the command line as follows:

content-type-editor path/to/the/project

For a complete list of available command-line options, run content-type-editor with the -h option:

content-type-editor -h

Copyright

Copyright © 2025 Jaromir Hradilek

This program is free software, released under the terms of the MIT license. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

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

content_type_editor-0.9.5.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

content_type_editor-0.9.5-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file content_type_editor-0.9.5.tar.gz.

File metadata

  • Download URL: content_type_editor-0.9.5.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for content_type_editor-0.9.5.tar.gz
Algorithm Hash digest
SHA256 c19a31e3afde2f0d9cd007c8c307cedac9980499bdde34322b05e4358f6603bd
MD5 88347c9a998101eb8888e79fd52ceb5d
BLAKE2b-256 ec60255862566971a16e5364ae1d1704e27fe4b686f549151725480debabcb6d

See more details on using hashes here.

File details

Details for the file content_type_editor-0.9.5-py3-none-any.whl.

File metadata

File hashes

Hashes for content_type_editor-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ae685ab65ac7deccd8eb8a96a0fa946927a757daaa7461874233d349149e4387
MD5 dc3f80e5233306a899efe49e424dfb02
BLAKE2b-256 4fd17cc6d0d0bf4f12688eefa0493557f88cba0b08a678eceab613737c17a411

See more details on using hashes here.

Supported by

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