From 924972af7f8c9ff1a902505b72798afda5fa3aae Mon Sep 17 00:00:00 2001 From: Andrew Pardoe Date: Sun, 20 Mar 2016 17:23:37 -0700 Subject: [PATCH] Added instructions for how to update the GitHub IO --- INSTRUCTIONS.txt | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 INSTRUCTIONS.txt diff --git a/INSTRUCTIONS.txt b/INSTRUCTIONS.txt new file mode 100644 index 0000000..500e401 --- /dev/null +++ b/INSTRUCTIONS.txt @@ -0,0 +1,21 @@ +How to update the gh-pages at http://isocpp.github.io/CppCoreGuidelines/ + +1. git checkout master +2. Update date in CppCoreGuidelines.md file +3. Copy CppCoreGuidelines.md to a temporary location +4. git checkout gh-pages +5. Add the following three lines to the top of CppCoreGuidelines.md: + +--- +layout: default +--- + +6. Replace all instances of {{ with {{ "{{" }} + This escapes the Liquid Template tag which has format {{ liquid }} + If you're lucky enough to use vi, your command is: %s/{{/{{ "{{" }}/g + +7. git commit -a +8. git push +9. Refresh the http://isocpp.github.io/CppCoreGuidelines/ to verify that the +build succeeded. If not, check your email! If the page fails to build, you'll +get a mail explaining why.