Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document usage of this theme #1

Open
3 tasks
rufuspollock opened this issue Dec 3, 2015 · 2 comments
Open
3 tasks

Document usage of this theme #1

rufuspollock opened this issue Dec 3, 2015 · 2 comments
Assignees

Comments

@rufuspollock
Copy link
Member

Discussed with @smth adding some info to README about usage

  • how to apply - e.g. do you submodule, copy and paste, do you hotlink css or copy locally etc
    • PS: shall we support hotlinking by making a gh-pages branch here and pushing this live?? If so do we need versioning as per jekyll-theme repo?
  • what you don't need and can delete for barebones usage
  • key configuration options in the _config.yml file
@rufuspollock
Copy link
Member Author

Configuration worth documenting:

  • using defaults in _config.yml
  • standard layouts to use
  • usage of sections to set section headers
  • edit being set to true or false
  • usage and meaning of wide: true

@smth
Copy link
Contributor

smth commented Dec 8, 2015

I have expanded the readme to cover most of this https://github.com/okfn/handbook-theme/blob/theme/README.md

With regard to providing hot-linkable CSS, I'd say no. People are much better off having the ability to edit the SASS files. I don't see any reason to encourage otherwise.

I don't really have a good answer in terms of what can be deleted. A lot of template stuff has been removed already. There is probably a fair bit of CSS that could be removed. All of this really depends on the content of the new site though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants