thegreenwebfoundation / datasets

Open datasets & methodologies for carbon emissions from different activities. Forked from OpenAMEE, and npm installable
MIT License
9 stars 1 forks source link

Convert missing Markdown files, fix subscripts, and fix README #7

Closed mamhoff closed 5 years ago

mamhoff commented 5 years ago

This PR contains various fixes for the previous slightly hasty PR, #4. That PR, contrary to its title, did not convert all documentation.creole files into Markdown - only the majority. More about the details at the bottom of this PR description.

Also, @mrchrisadams and I speculated that initially, people chose .creole because it has a syntax for subscripts. Markdown does have support for subscripts, so we fix that as well so that all the little chemical formulae look good. We used Commonmark as the conversion target in pandoc, and Commonmark does not include this syntax in the core standard. Github supports it though, and it looks great!

Finally, this PR replaces a reference to documentation.creole files from the global README file. They've all been converted to Markdown.

The previous commit, f114a9780, that attempted to convert all documentation.creole files into Markdown, only converted those files that had a file containing an f in their directory name (see the copy-pasted sh-fu in that commit - it contains the pattern *f* for looking for directories containing a creole file.

Here's the corrected sh command:

find . -type f -name 'documentation.creole' | sed -r 's|/[^/]+$||' |sort |uniq | while read line; do
cd $line
pwd
pandoc -s -f creole -t commonmark documentation.creole -o README.md
rm documentation.creole
cd -
done