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.4.tar.gz (8.9 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.4-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: content_type_editor-0.9.4.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for content_type_editor-0.9.4.tar.gz
Algorithm Hash digest
SHA256 8b0b9fc2cc2746b1b2f46bddfdac52cdf99ad22824247920bbeeb80b82a8bb95
MD5 497e324f4d5e10d0afd9aa9d8923a07e
BLAKE2b-256 4e42393208fbd1384388c8f2c19f6c71d2dac5ebbd5d1388f371a71ea6a03c03

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for content_type_editor-0.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1b14191f81f3254aa454eff0e4ff50034c718d2d3d2e8582dde484aee90e64f9
MD5 150df34c66c6cf4dc0d83092c9382601
BLAKE2b-256 d7e4b1eae4a48e3c33854201435bff437937a7e776ab620131e120b469cff91d

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