dreamalligator / sfsu.acm.org

#ACM at SFSU

Feel free to contribute!

See Pelican's Getting Started page.

• fork the repo
• git clone --recursive https://github.com/<username>/sfsu.acm.org.git
  • cd sfsu.acm.org
  • fork the acm-sfsu/pelican-cait theme.
  • git clone https://github.com/<username>/pelican-cait.git themes/pelican-cait/
• improve stuff, or write a post/article
  • make post or make page
  • test locally with pelican or make html
  • git commit -am 'brief but informative message'
  • git push origin source
• make a pull request!

If you need ideas on where to contribute, check out the issue list! Put issues related to theming (acm-sfsu/pelican-cait) here too.

If you have any questions, please drop by #acm-sfsu.

Windows users - see our Getting Started - Windows wiki page.

##Make

• make help - help

added commands

• make post and make page - see issue #4
• make sass - generates .css from .scss. Set THEME_NAME in Makefile. See Sass.

##Plugins Plugins can be added in the pelicanconf.py file's PLUGINS line.

###Render Math Render any LaTeX and math. See pelican-plugins/render_math.

• Issue #23

###Gallery

• Issue #8.

See pelican-plugins/gallery.

###Github Activity

• gha.html

See pelican-plugins/github_activity.

###Neighbors

• Issue #6

See pelican-plugins/neighbors.

###Gravatar See pelican-plugins/gravatar.

###Share Post

share_post creates old school URLs for some popular sites [...] these links do not have the ability to track the users.

See pelican-plugins/share_post.

###Liquid Tags

See pelican-plugins/liquid_tags]

• Issue #34
• Issue #35

put code in content/code/ folder and IPython notebooks in content/notebooks/.

We would love to see your science/projects/research, see ipython.org/notebook.html and a gallery of interesting IPython Notebooks.

##Metadata

Template: - (from acm/sfsu/pelican-cait takes) contact, landing, (from pelican-plugins/gallery takes) gallery for pages.

Gallery: - album_name, example: Gallery: 2014/02/21. At the moment this must be paired with Template: album, see issue #8.

Modified: - see issue #2.

Authors: - see issue #3.

Status: - hidden for pages, draft for articles.

##Dependencies If using pelican-plugins/github_activity will need feedparser. Get with pip install feedparser.

If using pelican-plugins/share_post need beautifulsoup4. Get with pip install beautifulsoup4.

If working on theme's CSS, will need Sass. Get with gem install sass.

When the pelican-plugins/liquid_tags plugin is in use, you'll need an ipython greater than 1.0. pip install ipython[all]