Closed anselmbradford closed 5 years ago
- Replaces homepage icons with SVGs.
Were you working off an old version of gh-pages? I did this a little while ago. (including the external link icon in the footer)
- Fixes issue where homepage images had their
alt
attributes erroneously namedclass
.
It would be better to just empty out these alt attributes, since the images do not have any content value to screen reader users.
Let's give it a whirl!
One other TODO we should state explicitly: If this works as expected, we'll need to update the contributing doc.
Fixes https://github.com/cfpb/capital-framework/issues/597
This is a first step in getting rid of the gh-pages branch hosted docs site, which is pain point for testing things and keeping the docs in sync with the changes in the codebase. This PR creates a
/docs
directory on the master branch and adds initial gulp tasks for handling the docs assets.This PR adds a /docs directory with jekyll template content largely from gh-pages, with the following differences:
alt
attributes erroneously namedclass
./components/grunt-tasks.md
.src/static/css/cf-enhancements.less
src/static/css/syntax.less
(appears to be redundant tocode.less
).src/static/gulpfile.js
src/static/js/main.js
and instead uses compiledcapital-framework.min.js
, though it probably should use amain.js
script in the future.Additions
gulp docs
task for copying documentation assets.gulp styles:docs
task for compiling documentation less files.Testing
gulp docs
should pass.If you want to run this locally you can follow the instructions on https://help.github.com/en/articles/setting-up-your-github-pages-site-locally-with-jekyll and run jekyll inside the
/docs
directory. However, you have to remove{{ site.github.url }}
from the templates (default.html
andhome.html
) to get the styles to apply.Notes
_layouts/post.html
was used anywhere, but left it for now.Todos