0a5fecea8d | ||
---|---|---|
.circleci | ||
.utils | ||
_data | ||
_includes | ||
_layouts | ||
_posts | ||
_sass | ||
assets | ||
node_modules | ||
.gitignore | ||
404.html | ||
Gemfile | ||
Gemfile.lock | ||
README.md | ||
_config.yml | ||
content-guidelines-example-two.md | ||
content-guidelines-example.md | ||
content-guidelines-master-template.md | ||
favicon.ico | ||
gulpfile.js | ||
index.md | ||
package.json | ||
yarn.lock |
README.md
Extension Workshop
Launchpad for why and how to build Firefox extensions
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
- Jekyll site generator for Github Pages
- Yarn Package Manager
- Codekit to compile javaScript
Content Updates
This site has two templates: the Extension Workshop landing page and Content Guidelines pages
How to add a Content Guidelines page
Create a new page
- Create new file
- Add header (see example below)
- Copy 'modules' needed from content-guidelines-master-template.md and paste in new file
- Save as markdown: page-name.md
---
layout: page
title: Page Name
permalink: /content-guidelines/page-name/
---
Upload media
- Navigate to /assets/img/ and click Upload files
- In your page, link to images using this page structure:
{{ site.baseurl }}/assets/img/image.jpg
Add the page to the menu
Go to data/content-guidelines-pages.yaml and add a new entry for your page:
- title: "Page Name"
url: "/content-guidelines/page-name/"
Deployment
Add additional notes about how to deploy this on a live system