Metadata-Version: 2.1
Name: dollardoc
Version: 0.1.0
Summary: Object oriented markdown documentation
Home-page: https://github.com/dollardoc/dollardoc
Author: dollardoc
Author-email: development@dollardoc.dev
License: UNKNOWN
Description: # DollarDoc
        
        Dollardoc is a unique documentation method that uses markdown and a pseudo object-oriented model to simplify documentation in complex environments. By utilizing dollar-plugins, dollardoc provides a featurefilled documentation method, while still being lightweight and straightforward.
        
        Initially designed with system architecture documentation in mind, dollardoc can be easily generalized for other documentation purposes.
        
        ## Getting Started
        
        To begin using dollardoc, set up a base Python project that installs the dollardoc dependency. You can also use the dollar-project-boilerplate project, which will provide you with a quick start.
        
        *...Chapter under development*
        
        ### Installation
        
        *...Chapter under development*
        
        ### Creating Your First Documentation File
        
        *...Chapter under development*
        
        ### Building the Documentation
        
        *...Chapter under development*
        
        ## Dollar Syntax Documentation
        
        *...Chapter under development*
        
        ## Outputs Supported
        
        Currently, this project only supports output for markdown files.
        
        ## Future of the Project
        
        * **Syntax specification**
          * An outline of the syntax specification is currently in progress.
        
        * **Better error handling**
          * Improve feedback from error messages by providing the row number in dollar-files.
        
        * **Support for tags**
          * Add the ability to create indirect links between different pages using tags. This simplifies the process of linking related documentation pages without requiring the creation of entire new pages.
        
Keywords: documentation,object-oriented,objectoriented,object oriented,markdown,processing,organize,version
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation
Classifier: Topic :: Education
Classifier: Topic :: Office/Business
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: Text Editors :: Word Processors
Classifier: Topic :: Text Editors :: Text Processing
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
