Skip to content

Commit fa461f5

Browse files
Andy-set-studiobmuenzenmeyer
authored andcommitted
Merge pull request #86 from acarlson0000/feature/update-documentation
Documentation / Reference updates & Handlebars vuln. fix
1 parent 3eec9e3 commit fa461f5

File tree

5 files changed

+68
-49
lines changed

5 files changed

+68
-49
lines changed

packages/docs/README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,27 @@ Get started now by **[deploying Hylia to Netlify.][deploy-to-netlify]**
1212

1313
Hylia version 0.5.0 features:
1414

15-
✍️ A pre-configured [Netlify CMS](https://www.netlifycms.org/) setup
16-
🎨 Customisable design tokens to make it your own
17-
🌍 Customisable global data and navigation
18-
📂 Tags and tag archives
19-
✅ Progressively enhanced, semantic and accessible
20-
🎈 _Super_ lightweight front-end
21-
🚰 Sass powered CSS system with utility class generator
22-
⚙️ Service worker that caches pages so people can read your articles offline
15+
✍️ A pre-configured [Netlify CMS](https://www.netlifycms.org/) setup
16+
🎨 Customisable design tokens to make it your own
17+
🌍 Customisable global data and navigation
18+
📂 Tags and tag archives
19+
✅ Progressively enhanced, semantic and accessible
20+
🎈 _Super_ lightweight front-end
21+
🚰 Sass powered CSS system with utility class generator
22+
⚙️ Service worker that caches pages so people can read your articles offline
2323
🚀 An RSS feed for your posts
2424

2525
## Roadmap
2626

27-
💬 [Netlify Forms](https://www.netlify.com/docs/form-handling/) powered comments
28-
💡 ~~Dark/Light mode toggle~~ [Added in 0.4.0](https://github.com/andybelldesign/hylia/releases/tag/0.4.0)
29-
🗣 Webmentions
30-
📖 Pagination
31-
🐦 Web sharing API integration
32-
🗒 Offline mode with links to cached pages
33-
📄 Documentation site
34-
💅 Proper Sass documentation
35-
✍️ Proper CMS documentation
27+
💬 [Netlify Forms](https://www.netlify.com/docs/form-handling/) powered comments
28+
💡 ~~Dark/Light mode toggle~~ [Added in 0.4.0](https://github.com/hankchizljaw/hylia/releases/tag/0.4.0)
29+
🗣 Webmentions
30+
📖 Pagination
31+
🐦 Web sharing API integration
32+
🗒 Offline mode with links to cached pages
33+
📄 Documentation site
34+
💅 Proper Sass documentation
35+
✍️ Proper CMS documentation
3636
🖼 A facility for you to be able to add your logo / branding
3737

3838
---
@@ -49,7 +49,7 @@ I recorded a quick start video of me deploying Hylia to Netlify and getting the
4949

5050
### Method two: Clone / Fork
5151

52-
1. Clone or fork this repo: `git clone https://github.com/andybelldesign/hylia`
52+
1. Clone or fork this repo: `git clone https://github.com/hankchizljaw/hylia`
5353
2. `cd` into the project directory and run `npm install`
5454
3. Once all the dependencies are installed run `npm start`
5555
4. Open your browser at `http://localhost:8080` and away you go!
@@ -109,25 +109,25 @@ Although Hylia has a pretty simple design, you can configure the core design tok
109109

110110
To change the design tokens in the CMS, find the “Globals” in the sidebar then in the presented options, select “Theme Settings”.
111111

112-
To change the design tokens directly, edit [`_src/data/tokens.json`](https://github.com/andybelldesign/hylia/blob/master/src/_data/tokens.json).
112+
To change the design tokens directly, edit [`_src/data/tokens.json`](https://github.com/hankchizljaw/hylia/blob/master/src/_data/tokens.json).
113113

114114
The tokens are converted into maps that the Sass uses to compile the front-end CSS, so make sure that you maintain the correct structure of `tokens.json`.
115115

116116
### Styleguide
117117

118118
Your version of Hylia ships with a Styleguide by default. You can see a demo of the Styleguide at <https://hylia.website/styleguide/>.
119119

120-
You can edit the Styleguide by opening [`src/styleguide.njk`](https://github.com/andybelldesign/hylia/blob/master/src/styleguide.njk). If you don’t want the Styleguide, delete that file and the page will vanish.
120+
You can edit the Styleguide by opening [`src/styleguide.njk`](https://github.com/hankchizljaw/hylia/blob/master/src/styleguide.njk). If you don’t want the Styleguide, delete that file and the page will vanish.
121121

122122
## Sass
123123

124-
Hylia is based on the [WIP v2 version of Stalfos](https://github.com/andybelldesign/stalfos/tree/feature/v2), which currently has no documentation (I know, I’m bad). Here is some very basic documentation for elements of the new framework that you will encounter on this project.
124+
Hylia is based on the [WIP v2 version of Stalfos](https://github.com/hankchizljaw/stalfos/tree/feature/v2), which currently has no documentation (I know, I’m bad). Here is some very basic documentation for elements of the new framework that you will encounter on this project.
125125

126126
### Configuration
127127

128-
The whole Sass system is powered by central config file, which lives here: [`_src/scss/_config.scss`](https://github.com/andybelldesign/hylia/blob/master/src/scss/_config.scss).
128+
The whole Sass system is powered by central config file, which lives here: [`_src/scss/_config.scss`](https://github.com/hankchizljaw/hylia/blob/master/src/scss/_config.scss).
129129

130-
Before Sass is compiled, a `_tokens.scss` file is generated from the [design tokens config](https://github.com/andybelldesign/hylia/blob/master/src/_data/tokens.json) which is required.
130+
Before Sass is compiled, a `_tokens.scss` file is generated from the [design tokens config](https://github.com/hankchizljaw/hylia/blob/master/src/_data/tokens.json) which is required.
131131

132132
Key elements:
133133

@@ -181,7 +181,7 @@ Pass in the key of one of your breakpoints set in `$stalfos-config['breakpoints'
181181

182182
## CMS
183183

184-
Hylia has [Netlify CMS](https://www.netlifycms.org/) pre-configured as standard. You can customise the configuration by editing [`src/admin/config.yml`](https://github.com/andybelldesign/hylia/blob/master/src/admin/config.yml).
184+
Hylia has [Netlify CMS](https://www.netlifycms.org/) pre-configured as standard. You can customise the configuration by editing [`src/admin/config.yml`](https://github.com/hankchizljaw/hylia/blob/master/src/admin/config.yml).
185185

186186
### Content that you can edit
187187

@@ -196,12 +196,12 @@ The basic CMS setup allows you to edit the following:
196196

197197
## Get involved
198198

199-
This project is _super_ early and feedback is very much welcome. In order to keep things running smooth, please consult the [contribution guide and code of conduct](https://github.com/andybelldesign/hylia/blob/master/contributing.md).
199+
This project is _super_ early and feedback is very much welcome. In order to keep things running smooth, please consult the [contribution guide and code of conduct](https://github.com/hankchizljaw/hylia/blob/master/contributing.md).
200200

201201
The stuff that I need the most help with is:
202202

203203
- Documentation
204204
- [Webmentions](https://www.w3.org/TR/webmention/)
205205
- Performance
206206

207-
[deploy-to-netlify]: https://app.netlify.com/start/deploy?repository=https://github.com/andybelldesign/hylia&stack=cms
207+
[deploy-to-netlify]: https://app.netlify.com/start/deploy?repository=https://github.com/hankchizljaw/hylia&stack=cms

packages/docs/package-lock.json

Lines changed: 36 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/docs/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"sass": "^1.21.0",
1515
"semver": "^6.3.0",
1616
"slugify": "^1.3.4",
17-
"stalfos": "github:andybelldesign/stalfos#c8971d22726326cfc04089b2da4d51eeb1ebb0eb"
17+
"stalfos": "github:hankchizljaw/stalfos#c8971d22726326cfc04089b2da4d51eeb1ebb0eb"
1818
},
1919
"devDependencies": {
2020
"@erquhart/rollup-plugin-node-builtins": "^2.1.5",
@@ -39,13 +39,13 @@
3939
},
4040
"repository": {
4141
"type": "git",
42-
"url": "git+https://github.com/andybelldesign/hylia.git"
42+
"url": "git+https://github.com/hankchizljaw/hylia.git"
4343
},
4444
"keywords": [],
4545
"author": "",
4646
"license": "MIT",
4747
"bugs": {
48-
"url": "https://github.com/andybelldesign/hylia/issues"
48+
"url": "https://github.com/hankchizljaw/hylia/issues"
4949
},
50-
"homepage": "https://github.com/andybelldesign/hylia#readme"
50+
"homepage": "https://github.com/hankchizljaw/hylia#readme"
5151
}

packages/docs/src/_data/navigation.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
},
88
{
99
"text": "GitHub",
10-
"url": "https://github.com/andybelldesign/hylia",
10+
"url": "https://github.com/hankchizljaw/hylia",
1111
"external": true
1212
},
1313
{

packages/docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ socialImage: ''
77
---
88
Hylia is a lightweight [Eleventy](https://11ty.io) starter kit with [Netlify CMS](https://www.netlifycms.org/) pre-configured, so that you can one-click install a progressive, accessible blog in minutes. It also gives you a well organised starting point to extend yourself.
99

10-
Get started now by [deploying Hylia to Netlify.](https://app.netlify.com/start/deploy?repository=https://github.com/andybelldesign/hylia&stack=cms)
10+
Get started now by [deploying Hylia to Netlify.](https://app.netlify.com/start/deploy?repository=https://github.com/hankchizljaw/hylia&stack=cms)

0 commit comments

Comments
 (0)