Skip to content
Permalink
Browse files

Use latest documentation on various guides

  • Loading branch information...
stp-ip committed May 7, 2019
1 parent 0b550d3 commit 92252e5f33300236f7fec5a0a1303e3966298bbd
Showing with 432 additions and 28 deletions.
  1. +1 −1 .seed-config.yaml
  2. +1 −21 CONTRIBUTING.md
  3. +2 −6 README.md
  4. +428 −0 docs/LICENSE
@@ -50,7 +50,7 @@ issueTemplate:
- "Hugo version"

badges:
- image: "https://img.shields.io/badge/state-beta-blue.svg"
- image: "https://img.shields.io/badge/state-stable-green.svg"
alt: "state"
- image: "https://img.shields.io/github/release/okkur/syna.svg"
link: "https://github.com/okkur/syna/releases"
@@ -19,27 +19,7 @@ This guide helps make contributing to Syna Theme simple and efficient for everyo
If you are starting out contributing to Syna Theme, there might be smaller scoped "starter issues" available:
[Current starter issues](https://github.com/okkur/syna/labels/starter%20issue)

Any changes in CSS/JS files or fonts require webpack which is managed with `package.json`'s npm scripts. You need to run the following commands which would install the required dependencies for building the changed files and start webpack for the build process itself.

```
make dep # Would install package.json's dependencies
make dev # Would start the build process for development
```

Prerequisites: node and yarn need to be installed on your system.

`make dev` would start webpack and any change you make to JS or CSS files would result in a build that is located in `static/`.

Keep in mind that JS and CSS files located in `static/` are bundled automatically reflecting the current state of the `static-main/` directory. Any file required in JS or style files (css, scss) is also bundled and put in `static/` directory from `static-main/`. Font files or images loaded in style files that have a relative path follow this rule.

On the other hand changes to layout files only need hugo. There is a demo available that we use to test as well as a demo. Any change to the entire site needs to be tested in the demo. If there is a new fragment it needs to be added to the demo as well. Demo is located in `exampleSite/` directory and it can be built using the following commands:

```
cd exampleSite
hugo -c content --config config.toml server -D
```

These commands will change the working directory to the demo directory and build that directory in watch mode (so any changes are reflected) with Syna as the theme.
For helping out developing on Syna directly take a look at our [developer documentation](https://syna.okkur.org/docs/development).

### Report bug

@@ -2,7 +2,7 @@

Highly customizable open source theme for Hugo based static websites

[![state](https://img.shields.io/badge/state-beta-blue.svg)]() [![release](https://img.shields.io/github/release/okkur/syna.svg)](https://github.com/okkur/syna/releases) [![license](https://img.shields.io/github/license/okkur/syna.svg)](LICENSE)
[![state](https://img.shields.io/badge/state-stable-green.svg)]() [![release](https://img.shields.io/github/release/okkur/syna.svg)](https://github.com/okkur/syna/releases) [![license](https://img.shields.io/github/license/okkur/syna.svg)](LICENSE)



@@ -12,17 +12,14 @@ Create your next website with Syna.
![Syna Theme screenshot](https://github.com/okkur/syna/blob/master/images/screenshot.png)

## Using Syna Theme

Start exploring [Syna](https://syna.okkur.org/demo).

To get started with your own website use our [starter repo](https://syna.okkur.org/start).
Or get started creating your own page with our [starter repo](https://syna.okkur.org/start).

## Documentation

Take a look at our full [documentation](https://syna.okkur.org/docs).

## Changelog

Detailed changes for each release are documented in the [release notes](https://syna.okkur.org/releases/).

## Support
@@ -44,4 +41,3 @@ Best place to start is our [contribution guide](/CONTRIBUTING.md).
---

Copyright 2017 - The Syna Theme Authors

0 comments on commit 92252e5

Please sign in to comment.
You can’t perform that action at this time.