CMSE Pelican/Github.io tutorial//colbrydi.github.io/msupelican/2018-07-02T00:00:00-04:00Installing the Software2018-07-02T00:00:00-04:002018-07-02T00:00:00-04:00authornametag:colbrydi.github.io,2018-07-02:/msupelican/installing-the-software.html<p>Before you start you will need to download some software. Pelican is based on python and github.io uses git. </p>
<p>We recommend using the Anaconda install for python. You can download the installer <a href="">here</a>.</p>
<p>Once Anaconda is installed you can use the installers to install the rest of what you …</p><p>Before you start you will need to download some software. Pelican is based on python and github.io uses git. </p>
<p>We recommend using the Anaconda install for python. You can download the installer <a href="">here</a>.</p>
<p>Once Anaconda is installed you can use the installers to install the rest of what you need:</p>
<p><code>conda install git</code></p>
<p><code>pip install pelican</code></p>
<p><code>pip install markdown</code></p>
<p>Now you should be able to clone this repository using the following commands:</p>
<p><code>git clone https://github.com/nolanfeeny/msupelican.git</code></p>Building your website2018-07-01T00:00:00-04:002018-07-01T00:00:00-04:00authornametag:colbrydi.github.io,2018-07-01:/msupelican/building-your-website.html<p>Once you have installed the required software and downloaded the repository, you should be able to now get this site running on your local machine. First change to the msupelican directory and run the following commands:</p>
<p><code>make html</code></p>
<p><code>make serve</code></p>
<p>If the above doesn't work it probably means you don't …</p><p>Once you have installed the required software and downloaded the repository, you should be able to now get this site running on your local machine. First change to the msupelican directory and run the following commands:</p>
<p><code>make html</code></p>
<p><code>make serve</code></p>
<p>If the above doesn't work it probably means you don't have make installed. You can use the following commands instead:</p>
<p><code>pelican content</code></p>
<p><code>cd docs && python -m pelican.server</code></p>
<p>To connect to the local site you can use the following URL:</p>
<p><a href="http://localhost:8000">http://localhost:8000</a></p>
<p>You are ready to start editing...</p>Making your github.io repository2018-07-01T00:00:00-04:002018-07-01T00:00:00-04:00authornametag:colbrydi.github.io,2018-07-01:/msupelican/making-your-githubio-repository.html<p>Running Pelican creates an <code>docs</code> folder with your static website. The next step is to take the contents of this folder and put it in a git repostiory named user.github.io where user is your github user name. That should be it. </p>
<ol>
<li>First you need a github account. You …</li></ol><p>Running Pelican creates an <code>docs</code> folder with your static website. The next step is to take the contents of this folder and put it in a git repostiory named user.github.io where user is your github user name. That should be it. </p>
<ol>
<li>First you need a github account. You can Create a github account here.</li>
<li>Second, create a repository named user.github.io. </li>
<li>Add the contents of <code>docs</code> to the user.github.io repository</li>
</ol>
<p>If you are new to github you may just want to drag and drop the contents of your <code>docs</code> directory into "add files" </p>Personalize Your Website2018-06-01T00:00:00-04:002018-06-01T00:00:00-04:00authornametag:colbrydi.github.io,2018-06-01:/msupelican/personalize-your-website.html<p>Now that you have a website it is time to make it your own. First thing you can do is edit the <code>pelican.conf</code> file. This file is used to set some variables related to your website. Read through the file and change what you think is appropriate Specifically change …</p><p>Now that you have a website it is time to make it your own. First thing you can do is edit the <code>pelican.conf</code> file. This file is used to set some variables related to your website. Read through the file and change what you think is appropriate Specifically change the following lines of code:</p>
<div class="highlight"><pre><span></span>AUTHOR = 'authorname'
SITENAME = "CMSE Pelican/Github.io tutorial"
</pre></div>
<p>Use your name and your website. Now just remake your repository using the make or pelican commands and view your changes on the local machine:</p>
<div class="highlight"><pre><span></span>make html
make serve
</pre></div>
<p>Once you are happy with the changes copy the contents of the <code>docs</code> directory to your user.github.io repository and push your changes to github.</p>Markdown File Tips & Tricks2018-05-31T00:00:00-04:002018-05-31T00:00:00-04:00authornametag:colbrydi.github.io,2018-05-31:/msupelican/markdown-file-tips-tricks.html<p>You will probably be using markdown files to write your blogs. They are nice because they give you more freedom than simple text files, and are easier to work with than HTML files. However, you can still use raw HTML in your files and it'll work pretty well, which is …</p><p>You will probably be using markdown files to write your blogs. They are nice because they give you more freedom than simple text files, and are easier to work with than HTML files. However, you can still use raw HTML in your files and it'll work pretty well, which is great for inserting more customized download links or files.</p>
<p>Here's a cheatsheet of good things to know:</p>
<p>Headers: </p>
<div class="highlight"><pre><span></span># H1
## H2
### H3
#### H4
##### H5
###### H6
</pre></div>
<h1>H1</h1>
<h2>H2</h2>
<h3>H3</h3>
<h4>H4</h4>
<h5>H5</h5>
<h6>H6</h6>
<div class="highlight"><pre><span></span>*italics*
**bold**
**_italics and bold_**
~~scratched text~~
</pre></div>
<p><em>italics</em><br>
<strong>bold</strong><br>
<strong><em>italics and bold</em></strong><br>
~~scratched text~~</p>
<div class="highlight"><pre><span></span>[I'm an inline-style link](https://www.google.com)
</pre></div>
<p><a href="https://www.google.com">I'm an inline-style link</a></p>
<p>Image<br>
<code>![lake michigan]({attach}../images/michigan.JPG)</code>
<img alt="lake michigan" src="//colbrydi.github.io/msupelican/michigan.JPG"></p>Making Additional Websites2018-05-30T00:00:00-04:002018-05-30T00:00:00-04:00authornametag:colbrydi.github.io,2018-05-30:/msupelican/making-additional-websites.html<p>Github Pages allows you to make unlimited websites linked to other repository projects.</p>
<p>For example, you have your main website <em>user</em>.github.io</p>
<p>If you have a separate github repository <em>projectrepo</em>, you can make a project column by going to the 'Projects' header and creating a new column. It can …</p><p>Github Pages allows you to make unlimited websites linked to other repository projects.</p>
<p>For example, you have your main website <em>user</em>.github.io</p>
<p>If you have a separate github repository <em>projectrepo</em>, you can make a project column by going to the 'Projects' header and creating a new column. It can be empty. </p>
<p><img alt="project" src="//colbrydi.github.io/msupelican/images/project.png"></p>
<p>Then, go to the 'settings' header and enable Github pages using the master branch. </p>
<p><img alt="settings" src="//colbrydi.github.io/msupelican/images/projsettings.png"></p>
<p>Now your html files in that repository should show up here: </p>
<p><code>https://*user*.github.io/</code><em>projectrepo</em></p>First Post2018-05-29T12:34:00-04:002018-05-29T12:34:00-04:00authornametag:colbrydi.github.io,2018-05-29:/msupelican/first-post.html<p>This is a sample post: you can post anything you want, e.g. for a blog, research paper, or general news update.</p>
<p>Here's a sample picture of Lake Michigan:</p>
<p><img alt="lake michigen" src="//colbrydi.github.io/msupelican/michigan.JPG"></p>
<p>This file is located at msupelican/content/Blog/firstpost.md and is written as a markdown file.</p>
<p>You probably will want …</p><p>This is a sample post: you can post anything you want, e.g. for a blog, research paper, or general news update.</p>
<p>Here's a sample picture of Lake Michigan:</p>
<p><img alt="lake michigen" src="//colbrydi.github.io/msupelican/michigan.JPG"></p>
<p>This file is located at msupelican/content/Blog/firstpost.md and is written as a markdown file.</p>
<p>You probably will want to delete the file once you make your own blog posts.</p>Adding Google Analytics to your site2017-07-02T00:00:00-04:002017-07-02T00:00:00-04:00authornametag:colbrydi.github.io,2017-07-02:/msupelican/adding-google-analytics-to-your-site.html<p>Google Analytics allows you to track the traffic on your website. </p>
<p>1 . First, create a Disqus account <a href="//disqus.com/admin/create/">here</a>
2. Once you have a Disqus account create a "new site" and point it to your github.io website. Remember the site name you used.
3. Open up the pelican.conf file …</p><p>Google Analytics allows you to track the traffic on your website. </p>
<p>1 . First, create a Disqus account <a href="//disqus.com/admin/create/">here</a>
2. Once you have a Disqus account create a "new site" and point it to your github.io website. Remember the site name you used.
3. Open up the pelican.conf file and uncomment the following line and add your site name to the script.</p>
<p>DISQUS_SITENAME = "YOUR SITE NAME"</p>
<p>That should be it. Run Pelican and push your changes to your github.io repository and you should now see comments </p>Adding Comments to your Blog2017-07-01T00:00:00-04:002017-07-01T00:00:00-04:00authornametag:colbrydi.github.io,2017-07-01:/msupelican/adding-comments-to-your-blog.html<p>Even though pelican generates static websites you can still have dynamic comments using a third party service called Disqus. </p>
<ol>
<li>First, create a Disqus account <a href="//disqus.com/admin/create/">here</a></li>
<li>Once you have a Disqus account create a "new site" and point it to your github.io website. Remember the site name you used.</li>
<li>Open …</li></ol><p>Even though pelican generates static websites you can still have dynamic comments using a third party service called Disqus. </p>
<ol>
<li>First, create a Disqus account <a href="//disqus.com/admin/create/">here</a></li>
<li>Once you have a Disqus account create a "new site" and point it to your github.io website. Remember the site name you used.</li>
<li>Open up the pelican.conf file and uncomment the following line and add your site name to the script.</li>
</ol>
<p>DISQUS_SITENAME = "YOUR SITE NAME"</p>
<p>That should be it. Run Pelican and push your changes to your github.io repository and you should now see comments </p>Connecting your Blog to Social Media2017-07-01T00:00:00-04:002017-07-01T00:00:00-04:00authornametag:colbrydi.github.io,2017-07-01:/msupelican/connecting-your-blog-to-social-media.html<p>Your blog can be used to automatically feed information into social media sites such as Twitter and facebook. This post will show you how to connect your github.io site to <a href="//dlvrit.com/">dlvrit.com</a>, a service which can read your blog and post entries into your social media outlets. </p>
<ol>
<li>Create an …</li></ol><p>Your blog can be used to automatically feed information into social media sites such as Twitter and facebook. This post will show you how to connect your github.io site to <a href="//dlvrit.com/">dlvrit.com</a>, a service which can read your blog and post entries into your social media outlets. </p>
<ol>
<li>Create an account in <a href="//dlvrit.com/">dlvrit.com</a> </li>
<li>Copy the RSS Feed link in for your blog. </li>
<li>Paste the URL in dlrit.com and connect your social media.</li>
</ol>
<p>That should be it. You do not need to change anything about your pelican post.</p>Making an academic publications page2017-06-01T00:00:00-04:002017-06-01T00:00:00-04:00authornametag:colbrydi.github.io,2017-06-01:/msupelican/making-an-academic-publications-page.html<p>For an academic website, publications are often useful. This post describes a process for adding publications to your pelican website using pelican. You can view the page generated using this post here:</p>
<p><a href="./pages/publications">Publications</a></p>
<h1>Step 1: Generate bibtex file</h1>
<p>First you need a bibtex file. This tutorial has only been tested …</p><p>For an academic website, publications are often useful. This post describes a process for adding publications to your pelican website using pelican. You can view the page generated using this post here:</p>
<p><a href="./pages/publications">Publications</a></p>
<h1>Step 1: Generate bibtex file</h1>
<p>First you need a bibtex file. This tutorial has only been tested with bibtex files generated by <a href="https://www.zotero.org/">Zotero</a>. </p>
<ul>
<li>In zotero, make a folder and add all references that you would like to see in your publications page. </li>
<li>Right-click on the folder and select <code>Export Collection...</code>. Pick the "Bibtex" option and save your file with the <code>bib2html/publications.bib</code> filename.</li>
</ul>
<h1>Step 2: Run the bib2html command</h1>
<p>Next you need to run the bib2html command to generate the basic html file. The provided makefile has a shortcut:</p>
<p><code>make bib</code></p>
<p>This will generate the <code>content/pages/publications.html</code> file. </p>
<h1>Step 3: Run the <code>make html</code> command as before</h1>
<p>Now that we have an a publications.html file we can run the <code>make html</code> command to add the pelican template components.</p>
<p><code>make html</code></p>
<h1>Final Notes</h1>
<p>This part of the tutorial is a work in progress. If you change your bib file you have to repeat the steps above. Here are some things to consider:</p>
<ul>
<li>Bibliogrphy entries must have <strong>author, title and year (or date)</strong>* to work.</li>
<li>Everytime you change the publications.bib file you need to run the <code>make bib</code> command.</li>
</ul>