i’m looking at you, charlie
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
- Discount documents some extra features we have available to us
- Any content that is blog-post-like in nature can be found in
app/_posts. - Any additional post should follow the naming convention
YYYY-MM-DD-post-title.md - If the footer requires additional copy, you can add it in
app/_includes/footer-extra-copy.md - If there’s text you need to update, but can't find, it might be hiding in
app/_layouts/default.htmlorapp/index.html. - If you are unclear on updating the html, ask a dev and we’re happy to help!
- Composer.js JavaScript MVC
- Jekyll
- Grunt.js
- Liquid templating language
- Install/switch to Ruby 2.2.2 (i recommend rbenv)
- In
package.json, update"name","description","author"and, using theusername/reposhorthand, update"repository" - In
Gruntfile.js, find the ports used for the local server (L102-103) and change them to… something else. Try not to collide with existing projects in case you ever want two servers running at once. gem install bundlerif it’s not already installednpm 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! 🎉
This boilerplate is set up to make travis autodeploys the easiest thing ever. To set them up, enable builds at https://travis-ci.org/$USERNAME/$REPO/settings/
General settings:
- Build only if .travis.yml is present
- Build pushes
- Limit concurrent jobs
- Build pull requests
Environment variables:
- GH_REF:
github.com/$USERNAME/$REPO - GH_TOKEN: you can generate this at https://github.com/settings/tokens
So, assuming deploy-ghpages.sh is written correctly (lol front-end developer
writing bash) travis will build pull requests to make sure they don't break, but
only actually deploy when things are merged to master. SO DON'T COMMIT TO
UPSTREAM MASTER. (i'm looking at you, lyon.)
app/_less
├── base
│ ├── common.less
│ └── variables.less
├── components
│ ├── animation.less
│ └── typography.less
├── core.less
├── lib
│ └── reset.less
└── partials
└── footer.less
- All Less files compiled and minified to
dist/css/core.css - 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 - Don’t worry about browser prefixes. Grunt handles that too.
js/main.jswill generally be used to contain the main page logic.js/controllerswill contain all Composer controllersjs/modelsis there for Composer models and collectionsjs/viewsfor Compser views. Use raw markup where you can, for speed.- This all compiles down to
dist/js/core.jsvia grunt, which also uglifies it - If you’re adding a javascript file, make sure to add its path to the files
array around L167 of
Gruntfile.js
-
TODO: design pattern library
-
TODO: build pattern library
-
TODO: launch pattern library
-
TODO: link pattern library here
-
Get the formal title, description, and planned URL from campaigner—use this to make appropriate changes to
config.yml -
Is this something that could be considered a stand-alone webapp? If so, check out
app/_includes/apple-touch-icons.html& include in<head>ofapp/_layouts/default.html -
delete one of the footers from
app/_layouts/default.html(fftf or fftfef). if there is additional text to be added to the footer, use the markdown file atapp/_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 %}