cfpb / docter Goto Github PK

I recently received this message from a gh-pages build:

The page build completed successfully, but returned the following warning:

You are attempting to use the 'pygments' highlighter, which is currently unsupported on GitHub Pages. Your site will use 'rouge' for highlighting instead. To suppress this warning, change the 'highlighter' value to 'rouge' in your '_config.yml'. For more information, see https://help.github.com/articles/page-build-failed-config-file-error/#fixing-highlighting-errors.

For information on troubleshooting Jekyll see:

https://help.github.com/articles/using-jekyll-with-pages#troubleshooting

If you have any questions you can contact us by replying to this email.

I think we need to update the pegged library versions, and, in the process, replace pygments with rouge.

Moving this issue from the design-manual repo to here

There are a few instances of directly styling all elements when you should probably use a class for example:

section:before {
    display: block; 
    content: ""; 
    height: 60px; 
    margin: -60px 0 0; 
}

...

header {
    width: 100%;
    border-top: 4px solid #2CB34A;
    border-bottom: 1px solid #BABBBD;
    background-color: #fff;
    position: fixed;
    top: 0;
    z-index: 99999;
    height: 3.625em;
}

Are you open to swapping some of these for class names?

We could maybe change the <section> element to <main>. Like:

<main id="main" class="main-content" role="main">
  {{ content }}
</main>

Here's a good article on the element.

Is there supposed to be a logo image in the header or is it intentionally left without a src vlaue?

Currently the typeface is "Avenir," which is the CFPB typeface. The Government Pattern Library uses Source Sans Pro.

Should we default to an open typeface to make this more usable by others while still using Avenir for CFPB projects?

I am using the templates for another organization and I would need to remove the favicon from the front page. I undertand that it is attached to the 18f_guides_template.gem file, but, is it possible to remove the favicon so it does not appear in the landing page?

Right now if no image is defined in the _config file, IE shows a broken image block. It would probably make sense to use an if block in the template to prevent this from happening when no image is defined.

At the top of the repo, it'd be nice to add in http://cfpb.github.io/DOCter/

Since we can't include it with the source.

When running jekyll serve --baseurl '' for the first time I got:

ERROR: YOUR SITE COULD NOT BE BUILT:
                    ------------------------------------
                    Missing dependency: redcarpet

The command line gave me instructions to fix it. I think it was something like $ gem install redcarpet. It worked but I wonder if this should be in the docs.

In the CSS there are .repo-list styles that are not being used on the demo site. Is it ok to delete them or do you have plans to use them?

Steps to reproduce

1. On the demo page click on Welcome to Jekyll!.
   You are now on a post page.
2. Click on any link in the sidebar nav for example click Another Example.
   You should get a 404 error.

Thoughts

• It looks like the sidebar links are relative to the post.
• Also the post page urls seem funny. Why do they start with /DOCter/jekyll/update/?

At first it was confusing that the navigation links on the left did not do anything because they all link to the same page. Maybe you can do something like you did here where the first items are anchor links within the home page and then you can have an example nav item that links to another page like you have already.