Skip to content

Commit

Permalink
Correct a few links and minor meta tweaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
XhmikosR authored and bep committed Feb 1, 2019
1 parent 042112e commit 9bfe65d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ <h3 class="f3 mv3 accent-color-light">We welcome all contributions</h3>
</a>
</li>
<li class="mb3 f4">
<a href="http://themes.gohugo.io" class="link mid-gray dim">
<a href="https://themes.gohugo.io/" class="link mid-gray dim">
Design a theme {{ partial "svg/link-ext.svg" (dict "fill" "#333" "size" "14") }}
</a>
</li>
Expand Down
16 changes: 7 additions & 9 deletions src/readme.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
## Welcome to the SRC folder for the Gohugo Theme.

The contents of this folder are used to generate CSS and javascript. You may never have to touch anything here, unless you want to more deeply customize your styles.
The contents of this folder are used to generate CSS and JavaScript. You may never have to touch anything here, unless you want to more deeply customize your styles.

## Tools

### NPM
### npm

We use [NPM](https://www.npmjs.com/) for package management The theme's `.gitignore` file should be kept intact to make sure that all files in the `node_modules` folder are not pushed to the repository.
We use [npm](https://www.npmjs.com/) for package management The theme's `.gitignore` file should be kept intact to make sure that all files in the `node_modules` folder are not pushed to the repository.

### Webpack

We use Webpack to manage our asset pipeline. Arguably, Webpack is overkill for this use-case, but we're using it here because once it's set up (which we've done for you), it's really easy to use. If you want to use an external script, just add it via Yarn, and reference it in main.js. You'll find instructions in the js/main.js file.

### PostCSS
PostCSS is just CSS. You'll find `postcss.config.js` in the css folder. There you'll find that we're using [`postcss-import`](https://github.com/postcss/postcss-import) which allows us import css files directly from the node_modules folder, [`postcss-cssnext`](http://cssnext.io/features/) which gives us the power to use upcoming CSS features today. If you miss Sass you can find PostCss modules for those capabilities, too.

PostCSS is just CSS. You'll find `postcss.config.js` in the css folder. There you'll find that we're using [`postcss-import`](https://github.com/postcss/postcss-import) which allows us import css files directly from the node_modules folder, [`postcss-cssnext`](http://cssnext.io/features/) which gives us the power to use upcoming CSS features today. If you miss Sass you can find PostCss modules for those capabilities, too.

### Tachyons

Expand All @@ -24,16 +24,14 @@ This theme uses the [Tachyons CSS Library](http://tachyons.io/). It's about 15kb

You'll find the commands to run in `src/package.json`.

For development, you'll need Node with NPM installed:
For development, you'll need Node with npm installed:

```
```bash
$ cd themes/gohugo-theme/src/
$ npm install
$ npm start
```

This will process both the postcss and scripts.

For production, instead of `npm start`, run `npm run build:production,` which will output minified versions of your files.
4 changes: 2 additions & 2 deletions theme.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

name = "Hugo Theme"
license = "MIT"
licenselink = "https://github.com/budparr/gohugo.io/blob/master/LICENSE.md"
licenselink = "https://github.com/gohugoio/gohugoioTheme/blob/master/license.md"
description = ""
homepage = "https://github.com/budparr/gohugo.io"
homepage = "https://github.com/gohugoio/gohugoioTheme"
tags = ["website"]
features = ["", ""]
min_version = 0.38
Expand Down

0 comments on commit 9bfe65d

Please sign in to comment.