scripts/gfm_to_html.py

#!/usr/bin/env python3

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

import pathlib
import sys

import cmarkgfm


def main() -> None:
    if len(sys.argv) < 3:
        print("Usage: gfm_to_html.py <input.md> <output.html>")
        sys.exit(1)

    input_path = pathlib.Path(sys.argv[1])
    output_path = pathlib.Path(sys.argv[2])

    markdown = input_path.read_text(encoding="utf-8")
    # cmarkgfm will refuse to write unsafe strings into the html
    html = cmarkgfm.github_flavored_markdown_to_html(markdown)
    output_path.write_text(html, encoding="utf-8")


if __name__ == "__main__":
    main()