CAMPAIGN AND WRITING PEOPLE READ HERE PLEASE
- Generally, content is written in Markdown format. You can find documentation
for this wonderful plain text formatting syntax all over:
- daringfireball, the source of markdown
- github's docs are super easy to follow
- kramdown documents some extra features we have available to us
- Any content that is blog-post-like in nature can be found in
site/_posts. - Blog posts should follow the naming convention
YYYY-MM-DD-post-title.md - If the footer requires additional copy, you can add it in
site/_includes/footer-extra-copy.md - If there’s text you need to update, but can't find, it might be hiding in
site/_layouts/default.htmlorsite/index.html. - If you are unclear on updating the html, ask a dev—we’re happy to help!
Fight for the Future campaigns are compiled by Jekyll, built using Grunt.js, deployed using Travis-CI, and hosted by GitHub pages.
- Install/switch to Ruby 2.3.1 (i recommend rbenv)
cp .env.example .envnpm installto install packages,npm startto run grunt (compiles assets, then watches for changes and compiles those too.)- A browser window will open pointed to the local server! 🎉
Free Progress employs a domain security token mechanism to whitelist new domains automatically. This can be built into the deploy process for campaign sites. The build task stored in scripts/generate_fp_token.js creates a file called public/freeprogress.txt which is a SHA256 hash of the Free Progress domain security token concatenated with the site's CNAME. In order for this to work, please do the following:
- Edit the
FP_DOMAIN_SECURITY_TOKENexport in.envto the correct value stored in the Free Progress environment. - Also add
FP_DOMAIN_SECURITY_TOKENas a hidden environment variable in Travis.
Travis will build on pull requests to make sure they don't break, but only actually deploy when PRs are merged to production. So always open pull requests.
less
├─ base
│ ├─ common.less
│ └─ variables.less
├─ components
│ ├─ animation.less
│ └─ typography.less
├─ core.less
├─ lib
│ └─ reset.less
└─ partials
└─ footer.less
- All Less files are compiled & autoprefixed on build—minified as well on deploy
- css files are saved to
public/css/core.csson local builds - css files are saved to
assets/css/core.csson deploy builds, then pushed toproject-name/css/core.csson S3 - When in doubt, make a new Less file and import it in
core.less—there’s no real performance hit as a result of good organization
- All js files are concatenated on build—minified as well on deploy
- js files are saved to
public/js/core.json local builds - js files are saved to
assets/js/core.json deploy builds, then pushed toproject-name/js/core.json S3 - When in doubt, make a new javascript file and add it to the javascript files array around L27 of Gruntfile.js
-
TODO: design pattern library
-
TODO: build pattern library
-
TODO: launch pattern library
-
TODO: link pattern library here
-
Is this something that could be considered a stand-alone webapp? If so, check out
site/_includes/apple-touch-icons.html& include in<head>ofsite/_layouts/default.html -
delete one of the footers from
site/_layouts/default.html(fftf or fftfef). if there is additional text to be added to the footer, use the markdown file atsite/_includes/footer-extra-copy.md
Cycle through markdown files in _posts directory
{% for post in site.posts %}
# [{{ post.title }}](#{{ post.slug }})
<time datetime="{{ post.date | date_to_rfc822 }}"></time>
{{ post.content }}
{% endfor %}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent