chg: [tools] Added sed to gen_misp_install_docs.sh to replace some formatting tildes which mkdocs does not really understand

chg: [docs] Minor touch-up to Changelog.md to correct for formatting issues.
chg: [config] Added correct paths to .gitignore for mkdocs
pull/3784/head
Steve Clement 2018-10-22 10:32:58 +09:00
parent e941964655
commit 1193cf8771
3 changed files with 230 additions and 222 deletions

6
.gitignore vendored
View File

@ -2,9 +2,9 @@
tools/misp-wipe/misp-wipe.conf
tools/misp-backup/misp-backup.conf
# Ignore mkdocs site directory
# /!\ UPDATE ONCE IN 2.4
INSTALL/ng/site/
# Ignore mkdocs site directory and mkdocs virtualenv
site/
tools/mkdocs
# Other
/vendors

File diff suppressed because it is too large Load Diff

View File

@ -14,5 +14,13 @@ if [ -z "$VIRTUAL_ENV" ]; then
virtualenv -p python3 mkdocs
${PWD}/mkdocs/bin/pip install mkdocs mkdocs-material
fi
wget -O ../docs/Changelog.md https://www.misp-project.org/Changelog.txt
# This search and replace is sub-optimal. It replaces 3 "~"s beginning of the line
# and then just replaces the remaining 2 following tildes in the document.
# This might change the sense of some commit messages...
sed -i "s/^\~\~\~/---/" ../docs/Changelog.md
sed -i "s/\~\~/--/g" ../docs/Changelog.md
# Deploy mkdocs to gh-pages branch
cd ../ ; ${PWD}/tools/mkdocs/bin/mkdocs gh-deploy