Plotly Academy

Usage

Setup

Clone this repository by entering git clone https://github.com/plotly/academy.git into your terminal
When that is finished, enter the directory of the repo with cd academy
Install the dependencies of this page with bundle install

Note: See Prerequisites.md if you encounter a problem with the initial setup.

Running locally

Enter bundle exec jekyll serve into your terminal
Open localhost:4000 in your browser

Typography

We use Typography.js to set up our typography styles. If you need to adjust the typography, follow the steps below:

Go to the scripts/ folder and run npm install.
Make changes to the generated typography css, make changes to write-typography.js
Run npm run write-typography. This will write out a file to the _sass src directory.

NOw you can just start jekyll like normally and the new styles will be there!

Adding a new tutorial

There are two types of tutorials: site internal tutorials, and external tutorials. Site internal tutorials are all tutorials that live in this repository and can be accessed directly at academy.plotly.com/tutorialname, e.g. the React tutorials.

External tutorials are links to tutorials that live on other websites.

Internal tutorials

Add your tutorial to the _config.yml as a collection like this:

collections:
  tutorialname:
    output: true
    permalink: /tutorialname/:path/index.html
    title: "Tutorial Title"
    category: "Frontend"

Add a folder in the root directory called _tutorialname, and put the Markdown files of the tutorial in there. That's it, your tutorial will now be visible on the homescreen!

Note the category field, this field can be one of these two values: "Frontend" or "Data Science"!

External tutorials

To add an external tutorial, again add your tutorial to the _config.yml as a collection but this time with output set to false:

collections:
  tutorialname:
    output: false
    title: "Tutorial Title"
    category: "Data Science"

Also similar to the internal tutorials, you again add a directory called _tutorialname to the root folder and put Markdown files in there, one for each tutorial part.

The difference lies within the Markdown files, instead of containing the parts themselves, they specify links_to in their YAML Front Matter, like this:

---
title: Test 1
description: This is a test external tutorial
links_to: http://plot.ly
---

And you'll see a list of your tutorial parts with links to the external sites on the homepage!

Licensing

Code released under the MIT license.

berraknil/academy