Powered by Jekyll and hosted by Github Pages.
$ git clone [email protected]:lessonly/lessonly.github.io.git
$ cd lessonly.github.io
$ bundle install
$ bundle exec jekyll serve
See your changes reflected at http:https://localhost:4000
- Create a branch.
- Commit your changes.
- Push the branch to Github.
- Open a pull request for discussion.
- Merge and Profit!
When using links be sure to use the liquid variable {{ site.github.url }} since we host the site on Github pages. Why?
When adding new content to our styleguide first create a new file within the _styleguide directory. The title of the page from the front-matter (e.g. "Ruby Style Guide") becomes the link text on the http:https://lessonly.github.io/styleguide listing.
Things to consider when adding content:
- Use examples! Examples help the rest of the team understand concepts and more clearly implement them.
- Sometimes the justification or link to the reasoning behind a standard is helpful to know. These help illustrate why we made the decision we did.
It's always good to get a second opinion when writing a new post to make sure it is relevant. Consider asking the team in chat if they think your new post topic on, "My Ruby Kittens gem. Awww cute" is something we can inspire other developers to read.
- jekyll post "My new draft name"
- Write your post
- When you are finished push your changes up to a new PR
- Let the team know the post is ready for content editing