128 lines
4.3 KiB
Bash
128 lines
4.3 KiB
Bash
#!/usr/bin/env bash
|
|
|
|
# Author: Zhang Huangbin <zhb _at_ iredmail.org>
|
|
# Purpose: Convert markdown articles to HTML files.
|
|
|
|
# Directory used to store converted html files.
|
|
PWD="."
|
|
SOURCE_DIR="${PWD}/src"
|
|
OUTPUT_DIR="${PWD}/html"
|
|
INDEX_MD="${OUTPUT_DIR}/index.md"
|
|
README_MD="${PWD}/README.md"
|
|
|
|
[ -d ${OUTPUT_DIR} ] || mkdir -p ${OUTPUT_DIR}
|
|
|
|
CMD_CONVERT="python ${PWD}/tools/markdown2html.py"
|
|
#CMD_CONVERT=":"
|
|
|
|
strip_name_prefix()
|
|
{
|
|
name="${1}"
|
|
name="$(echo ${name/#\.\//})" # ./filename
|
|
name="$(echo ${name/#[0-9][0-9][0-9]-/})" # nnn-
|
|
name="$(echo ${name/#[0-9][0-9]-/})" # nn-
|
|
name="$(echo ${name/#[0-9]-/})" # n-
|
|
echo "${name}"
|
|
}
|
|
|
|
# Chapter directories in specific order
|
|
all_chapter_dirs="installation \
|
|
howto \
|
|
integrations \
|
|
cluster \
|
|
backup-restore \
|
|
troubleshooting \
|
|
faq"
|
|
|
|
# Get chapter info
|
|
# - title: _title.md
|
|
# - summary: _summary.md
|
|
echo "We're working on migrating [old wiki documents](http://www.iredmail.org/wiki) to Markdown format for easier maintenance." > ${INDEX_MD}
|
|
echo "We're working on migrating [old wiki documents](http://www.iredmail.org/wiki) to Markdown format for easier maintenance." > ${README_MD}
|
|
|
|
for chapter_dir in ${all_chapter_dirs}; do
|
|
# Get articles
|
|
all_chapter_articles="$(find ${chapter_dir} -depth 1 -type f -iname '[0-9a-z]*.md')"
|
|
|
|
echo "* ${chapter_dir}/"
|
|
for article in ${all_chapter_articles}; do
|
|
echo " - ${article}"
|
|
done
|
|
|
|
# Output directory.
|
|
# Remove prefix '[number]-' in chapter directory name.
|
|
#chapter_dir_in_article="$(strip_name_prefix ${chapter_dir})"
|
|
#_output_chapter_dir="${OUTPUT_DIR}/${chapter_dir_in_article}"
|
|
|
|
# Get chapter title.
|
|
_title_md="${chapter_dir}/_title.md"
|
|
_summary_md="${chapter_dir}/_summary.md"
|
|
|
|
if [ -f ${_title_md} ]; then
|
|
# generate index info of chapter
|
|
_chapter_title="$(cat ${_title_md})"
|
|
echo -e "# ${_chapter_title}" >> ${INDEX_MD}
|
|
echo -e "# ${_chapter_title}" >> ${README_MD}
|
|
|
|
if [ -f ${_summary_md} ]; then
|
|
echo -e "$(cat ${_title_md})" >> ${INDEX_MD}
|
|
echo -e "$(cat ${_title_md})" >> ${README_MD}
|
|
fi
|
|
fi
|
|
|
|
#mkdir -p ${_output_chapter_dir} &>/dev/null
|
|
|
|
# Create ${_output_chapter_dir}/_summary.html
|
|
#if [ -f ${_summary_md} ]; then
|
|
# ${CMD_CONVERT} ${_summary_md} ${_output_chapter_dir}
|
|
#fi
|
|
|
|
# Article info:
|
|
# - title: first line (without '#') of markdown file
|
|
for article_file in ${all_chapter_articles}; do
|
|
article_file_basename="$(basename ${article_file})"
|
|
article_file_without_prefix_path="$(echo ${article_file/#\.\//})"
|
|
article_file_without_prefix="$(strip_name_prefix ${article_file})"
|
|
|
|
article_html_file="$(strip_name_prefix ${article_file_basename})"
|
|
# Replace '.md' suffix by '.html'
|
|
article_html_file="$(echo ${article_html_file/%.md/.html})"
|
|
|
|
# Get title.
|
|
_article_title="$(head -1 ${article_file} | awk -F'# ' '{print $2}')"
|
|
#_article_title="$(head -1 ${article_file} | awk -F'Title: ' '{print $2}')"
|
|
#echo "article title: ${_article_title}"
|
|
#echo "* [${_article_title}](${chapter_dir_in_article}/${article_html_file})" >> ${INDEX_MD}
|
|
echo "* [${_article_title}](${article_html_file})" >> ${INDEX_MD}
|
|
|
|
# 'src/default/' is path to view source file on bitbucket.org
|
|
echo "* [${_article_title}](https://bitbucket.org/zhb/docs.iredmail.org/src/default/${article_file_without_prefix_path})" >> ${README_MD}
|
|
|
|
#${CMD_CONVERT} ${article_file} ${_output_chapter_dir} \
|
|
${CMD_CONVERT} ${article_file} ${OUTPUT_DIR} \
|
|
output_filename="${article_html_file}" \
|
|
title="${_article_title}" \
|
|
add_index_link='yes'
|
|
done
|
|
|
|
# Append addition links at the chapter bottom on index page.
|
|
_links_md="${chapter_dir}/_links.md"
|
|
|
|
if [ -f ${_links_md} ]; then
|
|
cat ${_links_md} >> ${INDEX_MD}
|
|
cat ${_links_md} >> ${README_MD}
|
|
fi
|
|
|
|
done
|
|
|
|
#cd ${OUTPUT_DIR}
|
|
|
|
# Generate index.html
|
|
${CMD_CONVERT} ${INDEX_MD} ${OUTPUT_DIR} title="iRedMail Documentations"
|
|
|
|
# Cleanup
|
|
rm -f ${INDEX_MD}
|
|
|
|
# Copy to local hg repo of http://www.iredmail.org/docs/
|
|
cp -rf html/* ../web/docs/
|