Giter Club home page Giter Club logo

syna-start's Introduction

Syna Start

This is a sample project that can be used to jump start your Syna project. It uses Syna theme and Hugo with sample files that introduce two simple pages, one for landing and one for the about page.

Prerequisites

Installation

To start using this starter you need to clone or download this repository and update it's git submodules (Syna theme is added as a submodule).

git clone https://git.okkur.org/syna-start project-name && cd project-name
git submodule init
git submodule update

Usage

To start your website run the following commands:

Development:

$ hugo server -D # This command starts the Hugo server and watches the site directory for changes.

Production:

$ hugo # This command generates the static website in the public/ directory. If you do not have a site, then it gives errors about missing layout files.

Prerequisites: Go, Hugo

Directory Structure

We're using the standard directory structure using content pages.

├─ content/
|  └ _global/ # All global fragments are located in this directory
|  └ _index/ # Landing page is in this directory and it's url is changed to **/**.
|  └ about/ # About page
├ layouts/ # You can add extra layout files here. A sample custom fragment is available as a sample.
├ static/ # Your static files are in this directory.
├ themes/ # Hugo uses this directory as a default to look for themes. Syna theme is a git submodule available in this directory.
├ .gitignore
├ .gitmodules
├ config.toml # Hugo config file containing general settings and menu configs.

For storing images in the static directory, note that Syna fragments look for images in their own fragment directory, page directory and static/images directory. Read our image fallthrough documentation for more info.

Further details read our full documentation.

First Steps

Open index.md and type. The changes are visible almost immediately at http://localhost:1313/.

syna-start's People

Contributors

mpourismaiel avatar stp-ip avatar oddlittlebird avatar fv3rdugo avatar nzt-ventures avatar

Watchers

James Cloos avatar

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.