diff --git a/README.md b/README.md index 905b8d2..a30bf1b 100644 --- a/README.md +++ b/README.md @@ -86,23 +86,32 @@ storage_language: null output_dir: output/ # The directory in which files will be written # Destination directories names settings -prepend_h1: false # Add title of articles as Markdown h1, looks better on certain themes # Prepend ID to directory slug, preventing collisions # If false, a counter will be appended in case of name collision prepend_id: false -prepend_lang: false # Prepend lang of the object to directory slug (prenvents collision) -title_max_length: 40 # Maximum length of a single filename +# Prepend lang of the object to directory slug, prenventing collision between langs +prepend_lang: false +title_max_length: 42 # Maximum length (chars) of a single filename + +# Text body processing settings +remove_html: true # Should we clean remaining HTML blocks +metadata_markup: false # Should we keep markup (Markdown) in metadata fields, like title +unknown_char_replacement: ?? # String to replace broken encoding that cannot be repaired +prepend_h1: false # Add title of articles as Markdown h1, looks better on certain themes +# Array of objects with 2 or 3 values, allowing to move some fields into others. +# {src: moved_field_name, dest: destination_field_name, repr: "how to merge them"} +# repr is formatted with "{}" being the moved field, and "_" the destination one +# For example, to append a field "subtitle" to a field "title": +# - src: subtitle +# dest: title +# repr: "{} _" # (this is the default repr) +move_fields: [] # Ignored data settings export_drafts: true # Should we export drafts export_empty: true # Should we export empty articles ignore_patterns: [] # List of regexes : Matching sections or articles will be ignored -# Text body processing settings -remove_html: true # Should we clean remaining HTML blocks -metadata_markup: false # Should we keep markup (Markdown) in metadata fields (like title) -unknown_char_replacement: ?? # String to replace broken encoding that cannot be repaired - # Settings you probably don’t want to modify clear_log: true # Clear logfile between runs instead of appending to clear_output: true # Clear output dir between runs instead of merging into diff --git a/spip2md/config.py b/spip2md/config.py index 367742c..38ecb66 100644 --- a/spip2md/config.py +++ b/spip2md/config.py @@ -66,6 +66,7 @@ class Configuration: storage_language: Optional[str] = "fr" # Language of files and directories names output_dir: str = "output/" # The directory to which DB will be exported prepend_h1: bool = False # Add the title of the article as a Markdown h1 + move_fields: list[dict[str, str]] = [] # Alternative destination for fields prepend_id: bool = False # Add the ID of object before slug prepend_lang: bool = False # Add the lang of object before slug export_drafts: bool = True # Should we export drafts as draft:true articles