Documentation

Compass is a Jekyll theme designed with something very specific in mind: to be a simple and elegant personal landing page that can be easily deployed to GitHub Pages.

How to use Compass

Start by installing Bundler gem install bundler
Fork the Compass repository
Clone the repository you just forked: git clone https://github.com/YOUR-USER/compass
Then run bundle install to get Jekyll and all the dependencies.
Edit _config.yml as needed.
Run the Jekyll server with bundle exec jekyll serve
Go to http://localhost:4000

Deploy your site to GitHub Pages

If you want to use Compass as your personal landing page you can deploy your site to GitHub Pages as a User Page. To do so, when you are done modifying your clone, you should rename your repository to username.github.io where username is your username. When GitHub builds the page it will be made available at https://username.github.io.

If you are planning on using a custom domain to direct to your site, modify the CNAME file as described here.

Check the GitHub Pages Basics for more information.

All urls in site index file pointing to localhost

I remember having this problem before. When serving to GitHub Pages, assets aren't found. I've checked my config, the content.html file, and the _site index file. Currently, the index.html file in _site looks like this:

<!DOCTYPE html>
<html>

  <head>
    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Tiffany White &#8226; Check Yo Self: A Markdown Grammar Checker for Blog Posts</title>

    <link rel="apple-touch-icon" href="/images/chys.png" />
    <link rel="shortcut icon" sizes="16x16 24x24 32x32 48x48 64x64" href="http://localhost:4000/favicon.ico" />

    <link rel="stylesheet" href="/checkyoself/docs/assets/normalize.css">
    <link rel="stylesheet" href="/checkyoself/docs/assets/main.css">
    <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
    <link href='https://fonts.googleapis.com/css?family=Vollkorn' rel='stylesheet' type='text/css'>

    <link rel="canonical" href="http://localhost:4000/">

    <meta name="author" content="Tiffany White">
    <meta name="description" content="Check Yo Self: A Markdown Grammar Checker for Blog Posts" />

    <meta property="og:title" content="Check Yo Self: A Markdown Grammar Checker for Blog Posts" />
    <meta property="og:url" content="http://localhost:4000/" />
    <meta property="og:image" content="http://localhost:4000/checkyoself/docs/images/chys.png" />
    <meta property="og:description" content="" />
    <meta property="og:site_name" content="Check Yo Self: A Markdown Grammar Checker for Blog Posts">
    <!-- Here you can add your Google Analytics Tracking code. If you do so, do not
forget to set the include_analytics attribute to true on the _config.yml file -->

  </head>

  <body>

    <div class="wrapper">
      <header>

        <div class="logo-container">
          <a class="logo" href="" style="background-image: url('/checkyoself/docs/images/chys.png')"></a>
        </div>



        <div class="author-container">
          <h1>Tiffany White</h1></div>



        <div class="tagline-container">
          <p>Check Yo Self: A Markdown Grammar Checker for Blog Posts</p>
        </div>

      </header>
      <main>

        <div class="content">
          <h2>About Check Yo Self</h2>
          <p>Check Yo Self has a simple purpose: to check your markdown for grammatical errors and misspellings.</p>

          <h2>Features</h2>
          <ul>
            <li>Responsive design</li>
            <li>Mobile friendly</li>
            <li>You can pick up right were you left off with an account.</li>
          </ul>

          <p>For more information, including setup and configuration instructions, head over to <a href="https://twhite96.gitub.com/checkyoself/documentation">The Docs</a>.</p>
          <p>For bug reports and feature requests, pop on over to <a href="https://github.com/twhite96/checkyoself/issues">GitHub</a> and leave an issue.</p>

          <hr />

          <ul class="fa-ul main-list">
            <li class="main-list-item">
              <span class="fa fa-github fa-lg main-list-item-icon"></span>
              <a href="https://github.com/twhite96/checkyoself">GitHub Repository</a>
            </li>
            <li class="main-list-item">
              <span class="fa fa-user fa-lg main-list-item-icon"></span>
              <a href="https://twitter.com/TiffanyW_412">The Author</a>
            </li>
          </ul>

        </div>

      </main>
    </div>


  </body>

</html>

As you can see, some of these files are being served via localhost. Not sure how to solve it.

My repo

excentris / compass Goto Github PK

compass's Introduction

Documentation

How to use Compass

Deploy your site to GitHub Pages

compass's People

Contributors

Stargazers

Watchers

Forkers

compass's Issues

Failed to load the google font "Vollkorn" specified in head.html Due to using http instead of https

Your theme is listed in jekyllthemes.ru

All urls in site index file pointing to localhost

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

Jobs