Giter VIP home page Giter VIP logo

SmartLoad's Marketing Website

This is the GitHub project that maintains the SmartLoad marketing website. The website is built off of GitHub pages, which uses Jekyll to build static content. This website is maintained by kesh92 of SmartBear Software. The website takes its content from the gh-pages branch.

This Jekyll project is simply a directory of files, the source code for building a web site. A few directories have specialized uses for Jekyll and are denoted with an _ underscore beginning the name.

  • example-site: The Jekyll project is a Git repository. The top level contains configurations and files that will become root level pages in your site. Edit the overall site settings in _config.yml. Changes to _config.yml are not automatically refreshed during jekyll serve, you have to stop the server and restart.

  • _layouts: The basic templates for complete web pages, generally constructed with Liquid includes. They are called by YAML front matter on each page or post.

  • _includes: Modular chunks of HTML that can be called into a page layout by Liquid. For example {% include head.html %} in a page layout would add the include head.html from the _includes directory. This folder also contains this website's top level navigation headers which house the sign in and sign up button, and associated links.

  • _posts: Files in this directory will become blog post-like objects. They always have a date and title in the file name. If your site isn’t a blog, you don’t have to add a _posts directory. Other directories can be designated Collections to create regular groups of pages with properties similar to Posts. An example name of the md file for a blog post is 2017-04-18-first-post.md, with - acting as a way to add spaces.

  • _sass: Contains the modular .scss partials that will be pulled into your main CSS for the site.

  • assets, css, images: Directories without an underscore are copied to the generated site. One should contain a base SCSS file used to compile the partials into the site’s CSS file. Any file with no YAML front matter will also be simply copied without processing, for example images or java script libraries.

  • _site: This is the built out version of your new static site. Never modify files in this directory. It will be completely deleted and rebuilt with each jekyll serve or jekyll build. If you want to deploy your site to a static web host, copy this directory to your server!

Running Locally

You can run this website locally. Prerequisites include Ruby and Jekyll.

  • Clone this repository into your local machine.
  • cd into the root of the cloned repo
  • run bundle install

To run the local build, just enter this command in your terminal

bundle exec jekyll serve

Preview your local Jekyll site in the localhost, detailed in your terminal after running the above command. See the official GitHub documentation for doing this.

Working with the content

Anyone is welcome to add changes to the content. To make changes, please do the following -

  • Clone repository
  • Create a new branch, and add your changes to that branch
  • Create a PR to the main gh-pages branch

Any new commits to the gh-pages branch will automatically be picked up by GitHub pages, and new content should be reflected in the main marketing website in under 10 minutes.

Keshav V's Projects

cayman icon cayman

Cayman is a Jekyll theme for GitHub Pages

openapi.tools icon openapi.tools

A collection of Editors, Linters, Parsers, Code Generators, Documentation, Testing

ubuntu-repo icon ubuntu-repo

This is a repo for the engineering course I'm taking on Coursera. All code present here may likely break your computer

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.