README.md 2.36 KB
Newer Older
1
# hugo-solstice-theme
Christopher Guindon's avatar
Christopher Guindon committed
2

3
4
[![Build Status](https://travis-ci.org/EclipseFdn/hugo-solstice-theme.svg?branch=master)](https://travis-ci.org/EclipseFdn/hugo-solstice-theme)

Christopher Guindon's avatar
Christopher Guindon committed
5
## Getting Started
6

7
8
9
10
11
12
13
14
15
16
17
18
Dependencies:


| Program | Version |
|---------|---------|
| node.js | ~ 12.22.0 |
| npm | ~ 7.11 |
| Hugo | > 0.76 |
| Git | > 2.31 |
| Make | > 4.3 |


Christopher Guindon's avatar
Christopher Guindon committed
19
Install dependencies, build assets and start a webserver:
20

Christopher Guindon's avatar
Christopher Guindon committed
21
```bash
22
make run
Christopher Guindon's avatar
Christopher Guindon committed
23
```
24

25
26
27
28
29
30
31
32
33
34
35
36
37
38
To run npm watch and hugo server at the same time:

In one terminal:

```bash
npm run watch
```

Once above process is done, in another terminal:

```bash
make run
```

Christopher Guindon's avatar
Christopher Guindon committed
39
### Getting Started (Windows)
Martin Lowe's avatar
Martin Lowe committed
40

41
To install our dependencies on Windows, replace the previous `npm install`  with this one:
Yi Liu's avatar
Yi Liu committed
42
  
Christopher Guindon's avatar
Christopher Guindon committed
43
44
45
46
47
48
```bash
set NODE_ENV=production && npm install
```

#### Alternative Solution
  
Christopher Guindon's avatar
Christopher Guindon committed
49
Install [win-node-en](https://github.com/laggingreflex/win-node-env) globally and then install our dependencies by following the steps from our [Getting Started](https://github.com/EclipseFdn/hugo-solstice-theme#getting-started) section.
Christopher Guindon's avatar
Christopher Guindon committed
50
51
52
53
54

```bash
npm install -g win-node-env
```

Christopher Guindon's avatar
Christopher Guindon committed
55
### Known Issues
Christopher Guindon's avatar
Christopher Guindon committed
56
57
58
59

Versions of Hugo 0.60 and beyond do not support raw HTML in markdown files by default. To enable this feature, unsafe HTML rendering can be enabled in the Goldmark engine in the site configuration. This is not recommended as it exposes rendered content vulnerable to injected content on the site.


Christopher Guindon's avatar
Christopher Guindon committed
60
61
62
63
## Documentation

- <https://eclipsefdn-hugo-solstice-theme.netlify.com/>

Christopher Guindon's avatar
Christopher Guindon committed
64
## Bugs and Feature Requests
Christopher Guindon's avatar
Christopher Guindon committed
65
66

Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/eclipsefdn/hugo-solstice-theme/issues/new).
Yi Liu's avatar
Yi Liu committed
67

68
69
70
71
72
73
74
## Author

**Christopher Guindon (Eclipse Foundation)**

- <https://twitter.com/chrisguindon>
- <https://github.com/chrisguindon>

Christopher Guindon's avatar
Christopher Guindon committed
75
76
77
78
79
80
## Trademarks

* Jakarta and Jakarta EE are Trademarks of the Eclipse Foundation, Inc.
* Eclipse® is a Trademark of the Eclipse Foundation, Inc.
* Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.

Christopher Guindon's avatar
Christopher Guindon committed
81
## Copyright and License
82

Christopher Guindon's avatar
Christopher Guindon committed
83
Copyright 2018-2020 the [Eclipse Foundation, Inc.](https://www.eclipse.org) and the [hugo-solstice-theme authors](https://github.com/eclipsefdn/hugo-solstice-theme/graphs/contributors). Code released under the [Eclipse Public License Version 2.0 (EPL-2.0)](https://github.com/jakartaee/jakartaee.github.io/blob/src/LICENSE).