Metadata-Version: 1.1
Name: foliant
Version: 1.0.0
Summary: Modular, Markdown-based documentation generator that makes pdf, docx, html, and more.
Home-page: https://github.com/foliant-docs/foliant
Author: Konstantin Molchanov
Author-email: moigagoo@live.com
License: MIT
Download-URL: https://pypi.org/project/foliant
Description-Content-Type: UNKNOWN
Description: # Foliant
        
        Foliant is a all-in-one documentation authoring tool. It lets you produce standalone documents in pdf and docx, as well as websites, from single Markdown source.
        
        Foliant is a *higher order* tool, which means that it uses other programs to do its job. For pdf and docx, it uses [Pandoc](http://pandoc.org/), for websites it uses [MkDocs](http://www.mkdocs.org/).
        
        Foliant preprocessors let you include parts of documents in other documents, show and hide content with flags, render diagrams from text, and more.
        
        ## Installation
        
        Foliant is written in Python and requires Python 3.6.
        
        To install Foliant, use pip:
        
        ```shell
        $ pip install foliant
        ```
        
        Backends, extensions, and preprocessors are installed with pip as well. For the Quickstart, you'll need the [MkDocs backend]() and [init CLI extension]():
        
        ```shell
        $ pip install foliantcontrib.mkdocs foliantcontrib.init
        ```
        
        To build pdf and docx, install the [Pandoc backend]():
        
        ```shell
        $ pip install foliantcontrib.pandoc
        ```
        
        
        ## Quickstart
        
        1. Create a new project:
        
        ```shell
        $ foliant init
        Enter the project name: Hello Foliant
        ✓ Generating Foliant project
        ─────────────────────
        Project "Hello Foliant" created in /path/to/hello-foliant
        ```
        
        This command creates a basic Foliant project:
        
        ```
        hello-foliant/
        ├── foliant.yml
        └── src
            └── index.md
        
        1 directory, 2 files
        ```
        
        `foliant.yml` is the project config file, `src` is the directory that contains the project source files (initially, just one file `index.md`).
        
        2. Build a website from the newly created project:
        
        ```shell
        $ foliant make site -p hello-foliant/
        ✓ Parsing config
        ✓ Applying preprocessor mkdocs
        ✓ Making site with MkDocs
        ─────────────────────
        Result: Hello_Foliant-0.1.0-2017-11-24.mkdocs
        ```
        
        3. Run a local webserver in the site directory and see the site in your browser:
        
        ```shell
        $ cd Hello_Foliant-0.1.0-2017-11-24.mkdocs
        $ python -m http.server
        Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
        ```
        
        4. Build a standalone pdf document from the project:
        
        ```shell
        $ foliant make pdf -p hello-foliant/
        ✓ Parsing config
        ✓ Applying preprocessor mkdocs
        ✓ Making pdf with Pandoc
        ─────────────────────
        Result: Hello_Foliant-0.1.0-2017-11-24.pdf
        ```
        
        > **Important**
        >
        > To produce pdf, Pandoc first converts Markdown to tex and then coverts it to pdf. To convert pdf > from tex, you need to have a LaTeX distribution installed:
        >
        > -   [MacTeX](http://tug.org/mactex/) for macOS
        > -   [MikTeX](https://miktex.org/) for Windows
        > -   [TeXLive](https://tug.org/texlive/) for Linux
        
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3.6
