You've got something ready to submit, now what?

🕑 4 min • 👤 Thomas Graf • 📆 April 22, 2019 in Tutorials • 🏷 backend, github

Alright, let’s assume you’ve followed the instructions in the previous two posts on pandoc and the metadata header. You have a beautiful article that’s ready to be posted on the Outdex. But how do you get it there? The simplest option is to email it as an attachment to submissions@outde.xyz. One of the maintainers (probably me) will handle the backend stuff and send you a link to a preview version. If you’re happy with the preview, your article goes live. Otherwise, you mail in a revised version.

This process should work fine for simple documents that don’t need a lot of revising. But for those of you who are familiar with Github, we have a much slicker alternative.


Continue reading

Adding metadata to your article

🕑 4 min • 👤 Thomas Graf • 📆 April 20, 2019 in Tutorials • 🏷 backend, metadata, YAML

This is the second post on how to write submissions for the Outdex. The first one covered the use of pandoc for the actual content of your submission. However, a blog post is more than just its content. It also involves crucial metadata such as the author(s), the date it was published, or topic tags. Metadata also allows you to enable some advanced features. It’s a very powerful tool, but also very easy to use. All you have to do is add a short YAML-header at the very top. If that doesn’t mean anything to you, don’t despair, it only takes 4 minutes to learn.


Continue reading

Authoring articles with pandoc

🕑 7 min • 👤 Thomas Graf • 📆 March 09, 2019 in Tutorials • 🏷 backend, markdown, pandoc

This is the first post in an ongoing series of mini-tutorials for Outdex contributors. I’ll give a brief overview of some of the lovely pandoc features that authors can use for their outdex articles: formatting with markdown, syntax highlighting, Latex-style math, bibtex-style citations, and example numbering.

In the near future, there will be follow-up posts that cover the use of YAML headers for metadata, how to submit articles via Github, and some aspects of the talkyard commenting system we use. If anything’s unclear, please leave a comment.


Continue reading