Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kulfonjs/kulfon
:japanese_ogre: :frog: JavaScript static site generator with Org Mode & Markdown support (α) :boom:
https://github.com/kulfonjs/kulfon
javascript kulfon markdown nodejs nunjucks org-mode org-mode-export sass static-site static-site-generator
Last synced: 2 months ago
JSON representation
:japanese_ogre: :frog: JavaScript static site generator with Org Mode & Markdown support (α) :boom:
- Host: GitHub
- URL: https://github.com/kulfonjs/kulfon
- Owner: kulfonjs
- License: other
- Created: 2016-10-16T20:39:21.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T02:41:20.000Z (about 1 year ago)
- Last Synced: 2024-09-26T20:45:55.491Z (3 months ago)
- Topics: javascript, kulfon, markdown, nodejs, nunjucks, org-mode, org-mode-export, sass, static-site, static-site-generator
- Language: JavaScript
- Homepage: https://kulfon.org
- Size: 3.99 MB
- Stars: 118
- Watchers: 6
- Forks: 4
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - kulfonjs/kulfon - :japanese_ogre: :frog: JavaScript static site generator with Org Mode & Markdown support (α) :boom: (sass)
README
Kulfon
Static Site Generator for The Rest of Us
**Kulfon** /kuːl fəʊn/ is a *one command*, JavaScript static site generator
inspired by Hugo. It combines data sources with templates to tranform them into
HTML pages at once. It supports [Nunjucks](https://mozilla.github.io/nunjucks/),
[Markdown](https://en.wikipedia.org/wiki/Markdown) and [Org
Mode](https://orgmode.org/) out-of-the-box.
_This software is still under **active development** and not feature complete or ready for consumption by anyone other than software developers._
> \- Kulfon, Kulfon, co z Ciebie wyrośnie ?! martwię się już od tygodnia!
>
> \- Przestań!
While you're hesitating, listen to this wonderful [Kulfon song][5]!
## Demo
[](https://kulfon.net)
## Why Kulfon?
There is a ton of static site generators out there. Here are few points to
convince you to try **Kulfon**
* one-command tool, similar to [Hugo][3], but written in [JavaScript][6], so it's easier to integrate additional JavaScript libraries or stylesheets
* solid foundation with carefully selected tools to produce **smaller** websites **faster** as [The Average Webpage Is Now the Size of the Original Doom][8]
* [Rollup][7] for bundling javascripts
* [Sass][2] for stylesheets
* [Nunjucks][1] for views (a simple, designer friendly HTML-based syntax)
* written in ES6/ES2015
* [Org Mode](https://orgmode.org/) support
* [Markdown][15] support
* unified approach to external dependencies management with either [unpkg][13] or [Yarn][4]
* [HTTP/2][14] ready
## Installation
npm install -g kulfon
## Getting started
Once **Kulfon** is installed, you will have access to the `kulfon` command.
First, let's create a new project:
kulfon new
Now enter the directory
```
cd
```
and run `kulfon`'s server
```
kulfon serve
```
It creates `public` directory with compiled content (this directory should be
ignored). Go to `http://localhost:3000` to check your website.
For more commands, just type
```
kulfon
```
Visit [Getting Started](https://kulfon.org/docs/install/) for more.
## Roadmap
Kulfon keeps track of the upcoming fixes and features on GitHub Projects: [Kulfon Roadmap](https://github.com/kulfonjs/kulfon/projects/1)
## Websites that use Kulfon
If your website is using Kulfon, feel free to make a PR to add it to this list; please add the new entries at the top.
* https://nukomeet.com
* https://zaiste.net
* https://kulfon.org
## Bug reports
We use *Github Issues* for managing bug reports and feature requests. If you run
into problems, please search the *issues* or submit a new one here:
https://github.com/kulfonjs/kulfon/issues
Detailed bug reports are always great; it's event better if you are able to
include test cases.
[1]: https://mozilla.github.io/nunjucks/
[2]: http://sass-lang.com/
[3]: https://gohugo.io/
[4]: https://yarnpkg.com/
[5]: https://www.youtube.com/watch?v=YnsfCcxMydU
[6]: https://en.wikipedia.org/wiki/JavaScript
[7]: http://rollupjs.org/
[8]: https://www.wired.com/2016/04/average-webpage-now-size-original-doom/
[9]: https://developers.facebook.com/docs/sharing/webmasters#markup
[10]: https://dev.twitter.com/cards/overview
[11]: https://www.npmjs.com/
[12]: https://api-docs.npms.io/
[13]: https://unpkg.com/#/
[14]: https://en.wikipedia.org/wiki/HTTP/2
[15]: https://en.wikipedia.org/wiki/Markdown
[16]: https://kulfon.net/themes/default/
[17]: http://tachyons.io/
[18]: http://bourbon.io/
[19]: http://getbootstrap.com/