Research Computing Docs
This is a repository for storing and building documentation for the UCL RITS Research Computing services, using Jekyll and templates based on the UCL Indigo patterns.
It is automatically linted using MDL and built after each commit using Travis.
Please note that this is still an on-going conversion from a
MediaWiki dump, and not all pages have been converted yet.
If you see a page that is not converted, want to convert it,
and have vim and pandoc, you may want to try opening
it in vim, and using:
:%!pandoc -f mediawiki -t markdown_github
:g/^==*$/dl|exe "normal k" |s/^/## /
:g/^--*$/dl|exe "normal k" |s/^/### /
This should use pandoc to convert it, and convert the Setext-style headings into ATX-style ones. (Which I think are better for editing, but that's just my opinion, obviously.)
Editors using vim may also want to set up Syntastic with MDL to get the same linting client-side as on the Travis checks; instructions for how to do that will be pasted here when the style options have been hashed out.
Possible things to do
make a metrics layout for posts
should known issues be posts?
make a style guide (then tweak MDL options to fit)
