Next, run the script by clicking the triangular “play” button or selecting Run -> ConvertToMarkdown. It will ask you for permission to access your Google Docs and permission to send you an email. To convert your Google Doc into Markdown, copy this gdocs2md script from Github user Renato Mangini and insert it into your Google Doc’s script library by opening your Google Doc, navigating over to Tools -> Script editor… and then pasting the script into the Code.gs field like this: Headers look like this # Title and links like (). The following tutorial walks you through how to convert a Google Doc into RMarkdown and then upload it to a Github repository and then host it live on Github Pages. The good news is, if you can type your syllabus into Google Docs, you can build a site like this: But how to best share them with students? I’ll be publishing my “Digital Storytelling and Social Media” syllabus on Github using a simple website publishing format called RMarkdown. Add the front matter by typing the following.Professors across the country are scrambling to tidy up their syllabi. You can edit the file /_posts/-Hello-World.md.Īlternatively, you can create a new file and type /_posts/-Hello-World.md into the name section. There are also many other possible options that you can edit as well. Soon you should have a repository similar to mine.Įdit the config.yml file and add your site name and description. Go to the Jekyll Now page and click on fork to fork the repository to yours. You can follow the readme.md in this repostitory or continue below. You can install it using command line, but forking Jekyll Now, a repository with Jekyll already set up, would be easier. I prefer Jekyll since it can generate a website for you as well as provide tools for content creation. You can add these files to your repository. Here is a tutorial if you are not familiar with using html. You will want to start setting up an index.html and additional content for your website. You just need to type in the name of your repository. Now you can go on over to your new website and view it. My username is danhtruong, so I would type in,. In the repository name section, type in, where yourusername is your username. SetupĬreate a new repository in your GitHub profile. Jekyll supports Markdown and Liquid, a templating language that loads dynamic content on your site. Jekyll takes Markdown and HTML files and creates a complete static website based on your choice of layouts. Jekyll is a static site generator with built-in support for GitHub Pages and a simplified build process. I highly recommend using Jekyll so skip to the Jekyll section if you want to use Jekyll. Personally, I like Jekyll since it is simpler and has built-in tools for creating content, but others may want to use their own setup. In the next steps, we can either create a website from scratch or use Jekyll. Once you have one, it is as easy as creating your own repository. First, you will want to have a GitHub account, so head over there and create one. It lets you control your message.Ĭreating a website using GitHub Pages is free and also fairly easy. Having your own website will allow complete control of how you are presented. They have their own agenda with set templates for expressing yourself. While websites like LinkedIn and Twitter can be good sources of visibility. You can keep track of your research progress and highlight achievements along the way. You can also use your website as a professional history. Importantly, you can share your published papers freely, depending on the policies of your publisher. Unlike your CV or other social media websites, you can provide resources to other students or researchers in the form of protocols, code, and data. Your website also serves as an interactive CV that can provide a more visually appealing platform to present yourself. The most prominent reason that I believe in when creating your own website is to be able to share your research, highlight your progress, and advocate for yourself. In this post, I will give you a couple of reasons why you should make a website and give a tutorial on how to do so using GitHub Pages. You may have wondered whether or not you, yourself, should make one. As a student or early-career researcher, you may have seen a trend in professional websites created by your peers.
0 Comments
Leave a Reply. |