Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knotx/knotx-website
Knot.x Website Generator
https://github.com/knotx/knotx-website
generator hacktoberfest knotx static website
Last synced: 9 days ago
JSON representation
Knot.x Website Generator
- Host: GitHub
- URL: https://github.com/knotx/knotx-website
- Owner: Knotx
- License: apache-2.0
- Created: 2017-02-28T14:50:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T20:12:32.000Z (8 months ago)
- Last Synced: 2024-03-22T21:28:28.365Z (8 months ago)
- Topics: generator, hacktoberfest, knotx, static, website
- Language: HTML
- Homepage: https://knotx.io
- Size: 6.02 MB
- Stars: 2
- Watchers: 12
- Forks: 11
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KNOTX.io source repository
This repository contains Knot.x website source. The target website is generated using DocPad.
## Building
### Prerequisites
- Node.js v10.24.1
- Npm
### Bulding a dev version
If you have npm installed and want to work on website with live reload, just go to the repo and run
```
$> npm install
```
After all dependencies are downloaded run it as follows:
```
$> npm start
```
You will see something like this:
```
> [email protected] start C:\repos\knotx-website
> docpad-server
info: Welcome to DocPad v6.79.0 (global installation: C:\Repos\knotx-website\node_modules\docpad)
notice: Please donate to DocPad or have your company sponsor it: http://docpad.org/donate
info: Contribute: http://docpad.org/docs/contribute
info: Plugins: cleanurls, coffeescript, eco, highlightjs, less, livereload, marked, partials, stylus
info: Environment: development
info: LiveReload listening to new socket on channel /docpad-livereload
info: Server started on http://YOUR_MACHINE_NAME:3010
info: Generating...
info: Generated 31/42 files in 3.355 seconds
OK
```
The site is started on port `3010` under you machine name:
```
http://YOUR_MACHINE_NAME:3010
```
## Blogs
Read [BLOG-HOWTO.md](BLOG-HOWTO.md) for instructions how to write a blog post.
## Tutorials
Read [TUTORIAL-HOWTO.md](TUTORIAL-HOWTO.md) for instructions how to write a tutorial.
1. Add additional `remote` to this repository
```
$> git remote add gh [email protected]:Knotx/knotx.github.io.git
```
2. Clean `out/` folder
3. Deploy to Github Pages
```
$> npm run-script deploy-gh
```