Metadata-Version: 2.1
Name: fluidtopics-markdown
Version: 0.13.4
Summary: A Markdown to FluidTopics command line tool
License: LGPL-3.0-or-later
Keywords: FT,fluidtopics,CMS,Markdown
Author: Antidot Opensource
Author-email: opensource@antidot.net
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Dist: PyYAML (>=5.4.1,<6.0.0)
Requires-Dist: click (>=7,<8)
Requires-Dist: click-log (>=0.3,<0.4)
Requires-Dist: fluidtopics (>=1.0.3,<2.0.0)
Requires-Dist: importlib-metadata (>=3,<4)
Requires-Dist: lxml (>=4.5.1,<5.0.0)
Requires-Dist: python-slugify (>=4.0.0,<5.0.0)
Requires-Dist: requests (>=2.23.0,<3.0.0)
Project-URL: Documentation, https://doc.antidot.net/r/Technical-Notes/Markdown-to-Fluid-Topics-md2ft
Description-Content-Type: text/markdown

# Markdown to Fluitopics Command Line Tool

The purpose of this tool is to collect documentation existing in the form
of Markdown files from various places in a project and push it to
a [Fluid Topics](https://www.fluidtopics.com/) portal.

The tool uses the FTML connector:

- https://doc.fluidtopics.com/r/Upload-FTML-Content-to-Fluid-Topics/Configure-FTML-Content

## Features

- Collect all Markdown files (.md) contained in a project.
- Make it possible to define content as  public or internal based on [metadata contained
  in the Markdown files](https://stackoverflow.com/questions/44215896/markdown-metadata-format).
- Build the Table of Contents in FLuid Topics (ftmap) based on metadata contained in the Markdown files.
- Publish the collected documentation to a Fluid Topics portal.

## Documentation

Documentation of the md2ft commmand line tool is available [here](https://doc.fluidtopics.com/r/Technical-Notes/Markdown-to-Fluid-Topics-md2ft).

## Availability

fluidtopics-markdown is available:

- as a Python module: <https://pypi.org/project/fluidtopics-markdown/>
- as a Docker image that can be used along with a CI: <https://hub.docker.com/r/fluidtopics/markdown>

