Metadata-Version: 2.1
Name: mkdocs-table-of-figures
Version: 0.2.0
Summary: A MkDocs plugin listing all figures to create a table of figures page
Home-page: https://gitlab.com/cfpt-mkdocs-plugins/mkdocs-table-of-figures
Author: Thibaud Briard
Author-email: thibaud.brrd@eduge.ch
License: MIT
Description: # mkdocs-table-of-figures
        
        This is a plugin that creates a `figcaption` with elements `alt` attribute or title and lists all figures in files into a table of figures to be integrated in `Markdown` pages for MkDocs.
        
        ## Setup
        
        ### Installing using pip:
        
        `pip install mkdocs-table-of-figures`
        
        ## Config
        
        You need to activate the plugin in `mkdocs.yml`:
        
        ``` yaml
        plugins:
          - table-of-figures:
              title_label: "Table of figures of the documentation" # Optional --> Default : Table of Figures
              figure_label: "Figure N°" # Optional --> Default : Figure
              description_label: "Description of the figures" # Optional --> Default : Description
        
              temp_dir: "folder_name" # Optional --> Default : temp_figures
              file: "file_name" # Optional --> Default : figures.md
              
              on_mermaid: true # Optional --> Default : false
              on_codeblock: true # Optional --> Default : false
              on_table: true # Optional --> Default : false
        ```
        
        As you can see, every option is optional, but if you want to generate a table of figures in another language than English, you will need to set up label options.
        
        - `title_label` - This is the title (heading 1) given to the page that will contain the table of figures.
        - `figure_label` - This is the name given to every figure right before the auto-incremented number.
        - `description_label` - This is the label given to the column containing the description of each figure (alt text).
        - `temp_dir` - The temporary directory used to store the table of figures `Markdown` file before rendering to HTML. Only set this option if you already have a `temp_figures` folder in the root directory (same as `mkdocs.yml`), which you should not normally have.
        - `file` - The name of the `Markdown` file containing the table of figures. Only set this option if you already have a `figures.md` file in the `docs` directory.
        - `on_mermaid` - To enable `mermaid` diagrams support, need to use of `md_in_html` `Markdown` extension
        - `on_codeblock` - To enable code blocks support, need to use of `md_in_html` `Markdown` extension
        - `on_table` - To enable tables support, need to use of `md_in_html` `Markdown` extension
        
        ## Usage
        
        The plugin will only look for `Markdown` image composed of alt text. If you don't set any alt text for the `Markdown` image it will be ignored.
        
        There is two way of correctly rendering image stored within the docs:
        
        - Using url from base: this mean that you give the full path from the docs directory starting with `/` like this `/path/to/image/from/docs/image.png`
        - With the help of `md_in_html`: there is a `Markdown` extension that you can set in `mkdocs.yml` that allow the plugin to place `Markdown` in `HTML` which allow this plugin to let `MkDocs` set relative link in src attribute properly during `HTML` rendering
        
        Concerning external images nothing change.
        
        You can set the `md_in_html` option like so :
        
        ``` yaml
        markdown_extensions:
          - md_in_html
        ```
        
        Using the command `mkdocs build` or `mkdocs serve` will trigger the plugin if it has been set correctly in the config file.
        
        ## Support
        
        This plugin currently supports markdown images, `mermaid` diagrams, code blocks and table.
        
        To make a `mermaid` diagram, code block or table detectable by this plugin, you need to give it a title at the line just below it like this:
        
        ``` markdown
            ``` php
            <?php
              $var = 42;
            ?>
            ```
            The title of the code block go here
        ```
        
        ``` markdown
            ``` mermaid
            sequenceDiagram
                participant Alice
                participant Bob
                Alice->>John: Hello John, how are you?
                loop Healthcheck
                    John->>John: Fight against hypochondria
                end
                Note right of John: Rational thoughts <br/>prevail!
                John-->>Alice: Great!
                John->>Bob: How about you?
                Bob-->>John: Jolly good!
            ```
            The title of the mermaid diagram go here
        ```
        
        ``` markdown
            | Table   | Right | Center  | Left  |
            | ------- | ----: | :-----: | :---- |
            | A table |  With | Content | in it |
            The title of the table go here
        ```
        
        It will not work if there is a line between the element and the title.
        
        I highly recommend using `mkdocs-material` to use `mermaid` diagrams. For more info about `mermaid` diagrams, I invite you to check `mkdocs-material` and `mermaid`'s official documentation.
        
        I also recommend to add this stylesheet to prevent mermaid size from being reduced or code blocks from having code centered by mkdocs-material.
        
        ``` css
        figure.figure-mermaid {
            margin: 0 1em;
            width: 100%;
        }
        
        figure.figure-codeblock code {
            text-align: initial;
        }
        ```
        
        You can place the stylesheet in your `mkdocs.yml` at extra-css option
        
        ``` yml
        extra_css:
          - fix-mermaid-figure.css
        ```
        
        ## License
        
        This project is under MIT license. See the `license` file for more details.
        
        ## See Also
        
        - [GitLab Repo](http://www.gitlab.org/cfpt-mkdocs-plugins/mkdocs-table-of-figures/)
        - [MkDocs Website](http://www.mkdocs.org/)
        - [MkDocs-Material Documentation](https://squidfunk.github.io/mkdocs-material/)
        - [Mermaid Documentation](https://mermaid.org/intro/)
Keywords: mkdocs
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
