Git Product home page Git Product logo

site's Introduction

ligato.io Netlify Status

Contains the code for the Hugo-based Ligato.io website. Upon changes detected in the github repo, it will be deployed using Netlify to replace the existing Ligato.io site.

Instructions to Clone/Run

Step 1 - Install Hugo

Follow the instruction located here.

Don't worry about the theme in the quickstart guide. It is used just to get you going.

This site is using a modified Hugo-Fresh theme

Make sure you have the correct version of Hugo.

USER:ligato.io $ hugo version
Hugo Static Site Generator v0.54.0/extended darwin/amd64 BuildDate: unknown

Step 2 - Clone this site

The hugo-fresh theme is treated as a submodule. This is required by Netlify for automatic deployment.

Be sure to use THIS COMMAND:

git clone --recurse-submodules [email protected]:ligato/ligato.io.git 

Step 3 - Run it locally

cd ligato.io
hugo server -D

Go to localhost:1313 on your favorite browser and check it out.

This uses live reload so any changes will be instantaneous.

Some Comments

  • all content is written in markdown. For images, use markdown links or hugo shortcodes for images to work.

  • all content is contained in the content/ folder. You can see how sub-folders under content/ relate to specific content and corresponding templates in the layouts/ on the site.

  • all the content here is high-level. Detailed technical documentation is automatically retrieved from the Ligato docs repo and hosted on a readthedocs.org site which in turn is reachable by the documentation menu option at the top and various topic-specific pointers throughout the site.

  • Check the front matter of new content/ md files. Sidebar, templates, title, etc. may change depending on the location in website.

  • config.yaml is the main config file.

site's People

Contributors

chrismetz09 avatar jmedved avatar ondrej-fabry avatar vladolavor avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

site's Issues

Fix width/height attributes in svg images

Some of the svg images are not shown properly at currently deployed site.

This is how it looks for me:

image

It seems the cause is the missing width/height attributes.

This image does NOT have width/height attributes and is not shown:
https://github.com/ligato/ligato.io/blob/958e5a6fdf173e5b28bfff559cfc23522b8ddd6a/static/images/illustrations/icons/mouse-globe2.svg#L3

This image has width/height attributes and is shown ok:
https://github.com/ligato/ligato.io/blob/958e5a6fdf173e5b28bfff559cfc23522b8ddd6a/static/images/illustrations/icons/calendar-full.svg#L4

@chrismetz09 Try to ensure that everything looks OK by viewing the site deployed in the PR, before merging it.

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.